From 1610ba72db0bb5534210485028c19796a0ed3897 Mon Sep 17 00:00:00 2001 From: Eric Gustin Date: Tue, 17 Dec 2024 13:12:12 -0800 Subject: [PATCH] Update comments --- arcade/arcade/core/auth.py | 2 +- arcade/arcade/core/schema.py | 2 +- schemas/preview/tool_definition.schema.jsonc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/arcade/arcade/core/auth.py b/arcade/arcade/core/auth.py index 87e06e71..bec0dde4 100644 --- a/arcade/arcade/core/auth.py +++ b/arcade/arcade/core/auth.py @@ -14,7 +14,7 @@ class ToolAuthorization(BaseModel): model_config = ConfigDict(frozen=True) provider_id: str - """The unique provider kind configured in Arcade.""" + """The provider ID configured in Arcade.""" provider_type: AuthProviderType """The type of the authorization provider.""" diff --git a/arcade/arcade/core/schema.py b/arcade/arcade/core/schema.py index e7dbbd6c..bb46b65c 100644 --- a/arcade/arcade/core/schema.py +++ b/arcade/arcade/core/schema.py @@ -90,7 +90,7 @@ class ToolAuthRequirement(BaseModel): # The Arcade SDK translates these into the appropriate provider kind and type. # The only time the developer will set these is if they are using a custom auth provider. provider_id: Optional[str] = None - """A unique provider kind""" + """The provider ID.""" provider_type: str """The provider type.""" diff --git a/schemas/preview/tool_definition.schema.jsonc b/schemas/preview/tool_definition.schema.jsonc index 9b5c4d0e..7e615bb3 100644 --- a/schemas/preview/tool_definition.schema.jsonc +++ b/schemas/preview/tool_definition.schema.jsonc @@ -153,7 +153,7 @@ "properties": { "provider_id": { "type": "string", - "description": "A unique provider kind." + "description": "The provider ID." }, "provider_type": { "type": "string", @@ -161,7 +161,7 @@ }, "id": { "type": "string", - "description": "Optional unique identifier to distinguish between multiple providers of the same kind." + "description": "Optional unique identifier to distinguish between multiple providers with the same provider_id." }, "oauth2": { "type": "object",