Module

autodoc.models.openapi

OpenAPI-specific metadata dataclasses for autodoc system.

Provides typed metadata for:

  • API Overview (OpenAPIOverviewMetadata)
  • Endpoints (OpenAPIEndpointMetadata)
  • Schemas (OpenAPISchemaMetadata)
  • Parameters (OpenAPIParameterMetadata)
  • Request bodies (OpenAPIRequestBodyMetadata)
  • Responses (OpenAPIResponseMetadata)
View source
6 Classes

Classes

OpenAPIParameterMetadata dataclass
Metadata for OpenAPI parameter.
0

Metadata for OpenAPI parameter.

Attributes

Name Type Description
name str

Parameter name
location Literal['path', 'query', 'header', 'cookie']

Where parameter is located (path, query, header, cookie)
required bool

Whether parameter is required
schema_type str

Type of parameter
description str

Parameter description
OpenAPIRequestBodyMetadata dataclass
Metadata for OpenAPI request body.
0

Metadata for OpenAPI request body.

Attributes

Name Type Description
content_type str

Media type (e.g., "application/json")
schema_ref str | None

Reference to schema
required bool

Whether request body is required
description str

Request body description
OpenAPIResponseMetadata dataclass
Metadata for OpenAPI response.
0

Metadata for OpenAPI response.

Attributes

Name Type Description
status_code str

HTTP status code (e.g., "200", "404", "default")
description str

Response description
content_type str | None

Media type
schema_ref str | None

Reference to response schema
OpenAPIEndpointMetadata dataclass
Metadata specific to OpenAPI endpoints.
0

Metadata specific to OpenAPI endpoints.

Attributes

Name Type Description
method HTTPMethod

HTTP method (GET, POST, PUT, DELETE, etc.)
path str

URL path
operation_id str | None

Unique operation identifier
summary str | None

Short summary
tags tuple[str, ...]

Endpoint tags for grouping
parameters tuple[OpenAPIParameterMetadata, ...]

Request parameters
request_body OpenAPIRequestBodyMetadata | None

Request body metadata
responses tuple[OpenAPIResponseMetadata, ...]

Response metadata
security tuple[str, ...]

Security requirements
deprecated bool

Whether endpoint is deprecated
OpenAPIOverviewMetadata dataclass
Metadata for OpenAPI spec overview.
1

Metadata for OpenAPI spec overview.

Attributes

Name Type Description
version str | None

API version
servers tuple[str, ...]

Server URLs
security_schemes dict[str, Any]

Available security schemes
tags tuple[dict[str, Any], ...]

API tags with descriptions
Internal Methods 1
__hash__
Hash based on immutable fields only.
0 int 
def __hash__(self) -> int

Hash based on immutable fields only.

Returns

int

OpenAPISchemaMetadata dataclass
Metadata for OpenAPI schema/model.
1

Metadata for OpenAPI schema/model.

Attributes

Name Type Description
schema_type str | None

Type of schema (object, array, string, etc.)
properties dict[str, Any]

Schema properties
required tuple[str, ...]

Required property names
enum tuple[Any, ...] | None

Enum values if applicable
example Any

Example value
Internal Methods 1
__hash__
Hash based on immutable fields only.
0 int 
def __hash__(self) -> int

Hash based on immutable fields only.

Returns

int