flask-openapi 4.3.1__py3-none-any.whl

flask_openapi/models/media_type.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:46
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .encoding import Encoding
+from .example import Example
+from .reference import Reference
+from .schema import Schema
+
+
+class MediaType(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#media-type-object
+    """
+
+    media_type_schema: Reference | Schema | None = Field(default=None, alias="schema")
+    example: Any | None = None
+    examples: dict[str, Example | Reference] | None = None
+    encoding: dict[str, Encoding] | None = None
+
+    model_config = {"extra": "allow", "populate_by_name": True}

flask_openapi/models/oauth_flow.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:47
+
+from pydantic import BaseModel
+
+
+class OAuthFlow(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#oauth-flow-object
+    """
+
+    authorizationUrl: str | None = None
+    tokenUrl: str | None = None
+    refreshUrl: str | None = None
+    scopes: dict[str, str]
+
+    model_config = {"extra": "allow"}

flask_openapi/models/oauth_flows.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:47
+
+from pydantic import BaseModel
+
+from .oauth_flow import OAuthFlow
+
+
+class OAuthFlows(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#oauth-flows-object
+    """
+
+    implicit: OAuthFlow | None = None
+    password: OAuthFlow | None = None
+    clientCredentials: OAuthFlow | None = None
+    authorizationCode: OAuthFlow | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/operation.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:48
+
+from pydantic import BaseModel
+
+from .callback import Callback
+from .external_documentation import ExternalDocumentation
+from .parameter import Parameter
+from .reference import Reference
+from .request_body import RequestBody
+from .response import Response
+from .security_requirement import SecurityRequirement
+from .server import Server
+
+
+class Operation(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#operation-object
+    """
+
+    tags: list[str] | None = None
+    summary: str | None = None
+    description: str | None = None
+    externalDocs: ExternalDocumentation | None = None
+    operationId: str | None = None
+    parameters: list[Parameter] | None = None
+    requestBody: RequestBody | Reference | None = None
+    responses: dict[str, Response] | None = None
+    callbacks: dict[str, Callback] | None = None
+
+    deprecated: bool | None = False
+    security: list[SecurityRequirement] | None = None
+    servers: list[Server] | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/parameter.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:49
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .example import Example
+from .media_type import MediaType
+from .parameter_in_type import ParameterInType
+from .reference import Reference
+from .schema import Schema
+
+
+class Parameter(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#parameter-object
+    """
+
+    name: str
+    param_in: ParameterInType = Field(alias="in")
+    description: str | None = None
+    required: bool | None = None
+    deprecated: bool | None = None
+    allowEmptyValue: bool | None = None
+    style: str | None = None
+    explode: bool | None = None
+    allowReserved: bool | None = None
+    param_schema: Reference | Schema | None = Field(default=None, alias="schema")
+    example: Any | None = None
+    examples: dict[str, Example | Reference] | None = None
+    content: dict[str, MediaType] | None = None
+
+    model_config = {"extra": "allow", "populate_by_name": True}

flask_openapi/models/parameter_in_type.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:49
+from enum import Enum
+
+
+class ParameterInType(str, Enum):
+    """The place Parameters can be put when calling an Endpoint"""
+
+    QUERY = "query"
+    PATH = "path"
+    HEADER = "header"
+    COOKIE = "cookie"

flask_openapi/models/path_item.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:50
+import typing
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from .parameter import Parameter
+from .reference import Reference
+from .server import Server
+
+if typing.TYPE_CHECKING:  # pragma: no cover
+    from .operation import Operation
+
+
+class PathItem(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#path-item-object
+    """
+
+    ref: str | None = Field(default=None, alias="$ref")
+    summary: str | None = None
+    description: str | None = None
+    get: Optional["Operation"] = None
+    put: Optional["Operation"] = None
+    post: Optional["Operation"] = None
+    delete: Optional["Operation"] = None
+    options: Optional["Operation"] = None
+    head: Optional["Operation"] = None
+    patch: Optional["Operation"] = None
+    trace: Optional["Operation"] = None
+    servers: list[Server] | None = None
+    parameters: list[Parameter | Reference] | None = None
+
+    model_config = {"extra": "allow", "populate_by_name": True}

flask_openapi/models/paths.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:52
+from .path_item import PathItem
+
+"""
+https://spec.openapis.org/oas/v3.1.0#paths-object
+"""
+Paths = dict[str, PathItem]

flask_openapi/models/reference.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:53
+from pydantic import BaseModel, Field
+
+
+class Reference(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#reference-object
+    """
+
+    ref: str = Field(..., alias="$ref")
+
+    model_config = {"extra": "allow", "populate_by_name": True}

flask_openapi/models/request_body.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:53
+
+from pydantic import BaseModel
+
+from .media_type import MediaType
+
+
+class RequestBody(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#request-body-object
+    """
+
+    description: str | None = None
+    content: dict[str, MediaType]
+    required: bool | None = True
+
+    model_config = {"extra": "allow"}

flask_openapi/models/response.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:54
+
+from pydantic import BaseModel
+
+from .header import Header
+from .link import Link
+from .media_type import MediaType
+from .reference import Reference
+
+
+class Response(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#response-object
+    """
+
+    description: str
+    headers: dict[str, Header | Reference] | None = None
+    content: dict[str, MediaType] | None = None
+    links: dict[str, Link | Reference] | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/responses.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:55
+
+from .reference import Reference
+from .response import Response
+
+"""
+https://spec.openapis.org/oas/v3.1.0#responses-object
+"""
+Responses = dict[str, Response | Reference]

flask_openapi/models/schema.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:55
+from typing import Any, Union
+
+from pydantic import BaseModel, Field
+
+from .data_type import DataType
+from .discriminator import Discriminator
+from .external_documentation import ExternalDocumentation
+from .reference import Reference
+from .xml import XML
+
+
+class Schema(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#schema-object
+    """
+
+    ref: str | None = Field(alias="$ref", default=None)
+    title: str | None = None
+    multipleOf: float | None = Field(default=None, gt=0.0)
+    maximum: int | float | None = None
+    exclusiveMaximum: float | None = None
+    minimum: float | None = None
+    exclusiveMinimum: float | None = None
+    maxLength: int | None = Field(default=None, ge=0)
+    minLength: int | None = Field(default=None, ge=0)
+    pattern: str | None = None
+    maxItems: int | None = Field(default=None, ge=0)
+    minItems: int | None = Field(default=None, ge=0)
+    uniqueItems: bool | None = None
+    maxProperties: int | None = Field(default=None, ge=0)
+    minProperties: int | None = Field(default=None, ge=0)
+    required: list[str] | None = Field(default=None)
+    enum: None | list[Any] = Field(default=None)
+    type: DataType | None = Field(default=None)
+    allOf: list[Union[Reference, "Schema"]] | None = None
+    oneOf: list[Union[Reference, "Schema"]] | None = None
+    anyOf: list[Union[Reference, "Schema"]] | None = None
+    schema_not: Union[Reference, "Schema"] | None = Field(default=None, alias="not")
+    items: Union[Reference, "Schema"] | None = None
+    properties: dict[str, Union[Reference, "Schema"]] | None = None
+    prefixItems: list[Union[Reference, "Schema"]] | None = None
+    additionalProperties: Union[bool, Reference, "Schema"] | None = None
+    description: str | None = None
+    schema_format: str | None = Field(default=None, alias="format")
+    default: Any | None = None
+    nullable: bool | None = None
+    discriminator: Discriminator | None = None
+    readOnly: bool | None = None
+    writeOnly: bool | None = None
+    xml: XML | None = None
+    externalDocs: ExternalDocumentation | None = None
+    example: Any | None = None
+    deprecated: bool | None = None
+    const: Any | None = None
+
+    model_config = {"populate_by_name": True}

flask_openapi/models/security_requirement.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:56
+"""
+https://spec.openapis.org/oas/v3.1.0#security-requirement-object
+"""
+
+SecurityRequirement = dict[str, list[str]]

flask_openapi/models/security_scheme.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:56
+
+from pydantic import BaseModel, Field
+
+from .oauth_flows import OAuthFlows
+from .security_scheme_in_type import SecuritySchemeInType
+
+
+class SecurityScheme(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#security-scheme-object
+    """
+
+    type: str
+    description: str | None = None
+    name: str | None = None
+    security_scheme_in: SecuritySchemeInType | None = Field(default=None, alias="in")
+    scheme: str | None = None
+    bearerFormat: str | None = None
+    flows: OAuthFlows | None = None
+    openIdConnectUrl: str | None = None
+
+    model_config = {"extra": "allow", "populate_by_name": True}

flask_openapi/models/security_scheme_in_type.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/4/7 11:13
+from enum import Enum
+
+
+class SecuritySchemeInType(str, Enum):
+    """The place Parameters can be put when calling an Endpoint"""
+
+    QUERY = "query"
+    HEADER = "header"
+    COOKIE = "cookie"

flask_openapi/models/server.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2021/4/28 11:26
+
+from pydantic import BaseModel
+
+from .server_variable import ServerVariable
+
+
+class Server(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#server-object
+    """
+
+    url: str
+    description: str | None = None
+    variables: dict[str, ServerVariable] | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/server_variable.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:57
+
+from pydantic import BaseModel, Field
+
+
+class ServerVariable(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#server-variable-object
+    """
+
+    enum: list[str] | None = Field(None, min_length=1)
+    default: str
+    description: str | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/style_values.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/4/6 16:29
+from enum import Enum
+
+
+class StyleValues(str, Enum):
+    matrix = "matrix"
+    label = "label"
+    form = "form"
+    simple = "simple"
+    spaceDelimited = "spaceDelimited"
+    pipeDelimited = "pipeDelimited"
+    deepObject = "deepObject"

flask_openapi/models/tag.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel
+
+from .external_documentation import ExternalDocumentation
+
+
+class Tag(BaseModel):
+    """
+    https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#tag-object
+    """
+
+    name: str
+    description: str | None = None
+    externalDocs: ExternalDocumentation | None = None
+
+    model_config = {"extra": "allow"}

flask_openapi/models/validation_error.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2021/5/10 14:51
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class ValidationErrorModel(BaseModel):
+    # More information: https://docs.pydantic.dev/latest/concepts/models/#error-handling
+    type: str = Field(..., title="Error Type", description="A computer-readable identifier of the error type.")
+    loc: list[Any] = Field(..., title="Location", description="The error's location as a list.")
+    msg: str = Field(..., title="Message", description="A human readable explanation of the error.")
+    input: Any = Field(..., title="Input", description="The input provided for validation.")
+    url: str | None = Field(None, title="URL", description="The URL to further information about the error.")
+    ctx: dict[str, Any] | None = Field(
+        None,
+        title="Error context",
+        description="An optional object which contains values required to render the error message.",
+    )
+
+
+# backward compatibility
+UnprocessableEntity = ValidationErrorModel

flask_openapi/models/xml.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2023/7/4 9:58
+
+from pydantic import BaseModel
+
+
+class XML(BaseModel):
+    """
+    https://spec.openapis.org/oas/v3.1.0#xml-object
+    """
+
+    name: str | None = None
+    namespace: str | None = None
+    prefix: str | None = None
+    attribute: bool = False
+    wrapped: bool = False
+
+    model_config = {"extra": "allow"}