Regenerate python types from updated spec, per a2aproject/A2A#590

Author: mikeas1

src/a2a/types.py

@@ -6,27 +6,41 @@
 from enum import Enum
 from typing import Any, Literal
 
-from pydantic import BaseModel, RootModel
+from pydantic import BaseModel, Field, RootModel
 
 
 class A2A(RootModel[Any]):
     root: Any
 
 
-class AgentAuthentication(BaseModel):
+class In(Enum):
     """
-    Defines authentication requirements for an agent.
-    Intended to match OpenAPI authentication structure.
+    The location of the API key. Valid values are "query", "header", or "cookie".
     """
 
-    credentials: str | None = None
+    cookie = 'cookie'
+    header = 'header'
+    query = 'query'
+
+
+class APIKeySecurityScheme(BaseModel):
     """
-    credentials a client should use for private cards
+    API Key security scheme.
     """
-    schemes: list[str]
+
+    description: str | None = None
+    """
+    description of this security scheme
     """
-    e.g. Basic, Bearer
+    in_: In = Field(..., alias='in')
     """
+    The location of the API key. Valid values are "query", "header", or "cookie".
+    """
+    name: str
+    """
+    The name of the header, query or cookie parameter to be used.
+    """
+    type: Literal['apiKey'] = 'apiKey'
 
 
 class AgentCapabilities(BaseModel):
@@ -193,6 +207,30 @@ class FileWithUri(BaseModel):
     uri: str
 
 
+class HTTPAuthSecurityScheme(BaseModel):
+    """
+    HTTP Authentication security scheme.
+    """
+
+    bearerFormat: str | None = None
+    """
+    A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually
+    generated by an authorization server, so this information is primarily for documentation
+    purposes.
+    """
+    description: str | None = None
+    """
+    description of this security scheme
+    """
+    scheme: str
+    """
+    The name of the HTTP Authentication scheme to be used in the Authorization header as defined
+    in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry.
+    The value is case-insensitive, as defined in RFC7235.
+    """
+    type: Literal['http'] = 'http'
+
+
 class InternalError(BaseModel):
     """
     JSON-RPC error indicating an internal JSON-RPC error on the server.
@@ -403,6 +441,72 @@ class MethodNotFoundError(BaseModel):
     """
 
 
+class OAuthFlow(BaseModel):
+    """
+    Configuration details for a supported OAuth Flow
+    """
+
+    authorizationUrl: str
+    """
+    The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2
+    standard requires the use of TLS
+    """
+    refreshUrl: str
+    """
+    The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2
+    standard requires the use of TLS.
+    """
+    scopes: dict[str, str]
+    """
+    The available scopes for the OAuth2 security scheme. A map between the scope name and a short
+    description for it. The map MAY be empty.
+    """
+    tokenUrl: str
+    """
+    The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard
+    requires the use of TLS.
+    """
+
+
+class OAuthFlows(BaseModel):
+    """
+    Allows configuration of the supported OAuth Flows
+    """
+
+    authorizationCode: OAuthFlow | None = None
+    """
+    Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
+    """
+    clientCredentials: OAuthFlow | None = None
+    """
+    Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0
+    """
+    implicit: OAuthFlow | None = None
+    """
+    Configuration for the OAuth Implicit flow
+    """
+    password: OAuthFlow | None = None
+    """
+    Configuration for the OAuth Resource Owner Password flow
+    """
+
+
+class OpenIdConnectSecurityScheme(BaseModel):
+    """
+    OpenID Connect security scheme configuration.
+    """
+
+    description: str | None = None
+    """
+    description of this security scheme
+    """
+    openIdConnectUrl: str
+    """
+    Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.
+    """
+    type: Literal['openIdConnect'] = 'openIdConnect'
+
+
 class PartBase(BaseModel):
     """
     Base properties common to all message parts.
@@ -465,6 +569,17 @@ class PushNotificationNotSupportedError(BaseModel):
     """
 
 
+class SecuritySchemeBase(BaseModel):
+    """
+    Base properties shared by all security schemes.
+    """
+
+    description: str | None = None
+    """
+    description of this security scheme
+    """
+
+
 class TaskIdParams(BaseModel):
     """
     Parameters containing only a task ID, used for simple task operations.
@@ -654,64 +769,6 @@ class A2AError(
     )
 
 
-class AgentCard(BaseModel):
-    """
-    An AgentCard conveys key information:
-    - Overall details (version, name, description, uses)
-    - Skills: A set of capabilities the agent can perform
-    - Default modalities/content types supported by the agent.
-    - Authentication requirements
-    """
-
-    authentication: AgentAuthentication
-    """
-    Authentication requirements for the agent.
-    """
-    capabilities: AgentCapabilities
-    """
-    Optional capabilities supported by the agent.
-    """
-    defaultInputModes: list[str]
-    """
-    The set of interaction modes that the agent
-    supports across all skills. This can be overridden per-skill.
-    Supported mime types for input.
-    """
-    defaultOutputModes: list[str]
-    """
-    Supported mime types for output.
-    """
-    description: str
-    """
-    A human-readable description of the agent. Used to assist users and
-    other agents in understanding what the agent can do.
-    """
-    documentationUrl: str | None = None
-    """
-    A URL to documentation for the agent.
-    """
-    name: str
-    """
-    Human readable name of the agent.
-    """
-    provider: AgentProvider | None = None
-    """
-    The service provider of the agent
-    """
-    skills: list[AgentSkill]
-    """
-    Skills are a unit of capability that an agent can perform.
-    """
-    url: str
-    """
-    A URL to the address the agent is hosted at.
-    """
-    version: str
-    """
-    The version of the agent - format is up to the provider.
-    """
-
-
 class CancelTaskRequest(BaseModel):
     """
     JSON-RPC request model for the 'tasks/cancel' method.
@@ -878,13 +935,49 @@ class MessageSendConfiguration(BaseModel):
     """
 
 
+class OAuth2SecurityScheme(BaseModel):
+    """
+    OAuth2.0 security scheme configuration.
+    """
+
+    description: str | None = None
+    """
+    description of this security scheme
+    """
+    flows: OAuthFlows
+    """
+    An object containing configuration information for the flow types supported.
+    """
+    type: Literal['oauth2'] = 'oauth2'
+
+
 class Part(RootModel[TextPart | FilePart | DataPart]):
     root: TextPart | FilePart | DataPart
     """
     Represents a part of a message, which can be text, a file, or structured data.
     """
 
 
+class SecurityScheme(
+    RootModel[
+        APIKeySecurityScheme
+        | HTTPAuthSecurityScheme
+        | OAuth2SecurityScheme
+        | OpenIdConnectSecurityScheme
+    ]
+):
+    root: (
+        APIKeySecurityScheme
+        | HTTPAuthSecurityScheme
+        | OAuth2SecurityScheme
+        | OpenIdConnectSecurityScheme
+    )
+    """
+    Mirrors the OpenAPI Security Scheme Object
+    (https://swagger.io/specification/#security-scheme-object)
+    """
+
+
 class SetTaskPushNotificationConfigRequest(BaseModel):
     """
     JSON-RPC request model for the 'tasks/pushNotificationConfig/set' method.
@@ -931,6 +1024,68 @@ class SetTaskPushNotificationConfigSuccessResponse(BaseModel):
     """
 
 
+class AgentCard(BaseModel):
+    """
+    An AgentCard conveys key information:
+    - Overall details (version, name, description, uses)
+    - Skills: A set of capabilities the agent can perform
+    - Default modalities/content types supported by the agent.
+    - Authentication requirements
+    """
+
+    capabilities: AgentCapabilities
+    """
+    Optional capabilities supported by the agent.
+    """
+    defaultInputModes: list[str]
+    """
+    The set of interaction modes that the agent
+    supports across all skills. This can be overridden per-skill.
+    Supported mime types for input.
+    """
+    defaultOutputModes: list[str]
+    """
+    Supported mime types for output.
+    """
+    description: str
+    """
+    A human-readable description of the agent. Used to assist users and
+    other agents in understanding what the agent can do.
+    """
+    documentationUrl: str | None = None
+    """
+    A URL to documentation for the agent.
+    """
+    name: str
+    """
+    Human readable name of the agent.
+    """
+    provider: AgentProvider | None = None
+    """
+    The service provider of the agent
+    """
+    security: list[dict[str, list[str]]] | None = None
+    """
+    Security requirements for contacting the agent.
+    """
+    securitySchemes: dict[str, SecurityScheme] | None = None
+    """
+    Security scheme details used for authenticating with this agent.
+    """
+    skills: list[AgentSkill]
+    """
+    Skills are a unit of capability that an agent can perform.
+    """
+    url: str
+    """
+    A URL to the address the agent is hosted at.
+    """
+    version: str
+    """
+    The version of the agent - format is up to the provider.
+    """
+
+
 class Artifact(BaseModel):
     """
     Represents an artifact generated for a task task.