django-bolt 0.1.0__cp310-abi3-win_amd64.whl

django_bolt/openapi/spec/security_requirement.py

@@ -0,0 +1,28 @@
+from typing_extensions import TypeAlias
+
+SecurityRequirement: TypeAlias = "dict[str, list[str]]"
+"""Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a
+security scheme declared in the.
+
+`Security Schemes <https://spec.openapis.org/oas/v3.1.0#componentsSecuritySchemes>`_ under the
+`Components Object <https://spec.openapis.org/oas/v3.1.0#componentsObject>`_.
+
+Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to
+be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey
+security information.
+
+When a list of Security Requirement Objects is defined on the
+`OpenAPI Object <https://spec.openapis.org/oas/v3.1.0#oasObject>`_ or
+`Operation Object <https://spec.openapis.org/oas/v3.1.0#operationObject>`_, only one of the Security Requirement
+Objects in the list needs to be satisfied to authorize the request.
+
+Patterned Fields
+
+{name}: ``List[str]``
+Each name MUST correspond to a security scheme which is declared
+in the `Security Schemes <https://spec.openapis.org/oas/v3.1.0#componentsSecuritySchemes>`_ under the
+`Components Object <https://spec.openapis.org/oas/v3.1.0#componentsObject>`_. if the security scheme is of type
+``"oauth2"`` or ``"openIdConnect"``, then the value is a list of scope names required for the execution, and the list
+MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain
+a list of role names which are required for the execution,but are not otherwise defined or exchanged in-band.
+"""

django_bolt/openapi/spec/security_scheme.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Literal
+
+from .base import BaseSchemaObject
+
+if TYPE_CHECKING:
+    from .oauth_flows import OAuthFlows
+
+__all__ = ("SecurityScheme",)
+
+
+@dataclass
+class SecurityScheme(BaseSchemaObject):
+    """Defines a security scheme that can be used by the operations.
+
+    Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query
+    parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials
+    and authorization code) as defined in :rfc`6749`, and
+    `OpenID Connect Discovery <https://tools.ietf.org/html/draft-ietf-oauth-discovery-06>`_.
+
+    Please note that as of 2020, the implicit flow is about to be deprecated by
+    `OAuth 2.0 Security Best Current Practice <https://tools.ietf.org/html/draft-ietf-oauth-security-topics>`_.
+    Recommended for most use case is Authorization Code Grant flow with PKCE.
+    """
+
+    type: Literal["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"]
+    """**REQUIRED**. The type of the security scheme."""
+
+    description: str | None = None
+    """A description for security scheme.
+
+    `CommonMark syntax <https://spec.commonmark.org/>`_ MAY be used for rich text representation.
+    """
+
+    name: str | None = None
+    """
+    **REQUIRED** for ``apiKey``. The name of the header, query or cookie parameter to be used.
+    """
+
+    security_scheme_in: Literal["query", "header", "cookie"] | None = None
+    """
+    **REQUIRED** for ``apiKey``. The location of the API key.
+    """
+
+    scheme: str | None = None
+    """
+    **REQUIRED** for ``http``. The name of the HTTP Authorization scheme to be used in the
+    authorization header as defined in :rfc:`7235`.
+
+    The values used SHOULD be registered in the
+    `IANA Authentication Scheme registry <https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml>`_
+    """
+
+    bearer_format: 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.
+    """
+
+    flows: OAuthFlows | None = None
+    """**REQUIRED** for ``oauth2``. An object containing configuration information for the flow types supported."""
+
+    open_id_connect_url: str | None = None
+    """**REQUIRED** for ``openIdConnect``. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in
+    the form of a URL. The OpenID Connect standard requires the use of TLS.
+    """

django_bolt/openapi/spec/server.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from .base import BaseSchemaObject
+
+if TYPE_CHECKING:
+    from .server_variable import ServerVariable
+
+__all__ = ("Server",)
+
+
+@dataclass
+class Server(BaseSchemaObject):
+    """An object representing a Server."""
+
+    url: str
+    """
+    **REQUIRED**. A URL to the target host.
+
+    This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the
+    location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in
+    ``{brackets}``.
+    """
+
+    description: str | None = None
+    """An optional string describing the host designated by the URL.
+
+    `CommonMark syntax <https://spec.commonmark.org/>`_ MAY be used for rich text representation.
+    """
+
+    variables: dict[str, ServerVariable] | None = None
+    """A map between a variable name and its value. The value is used for substitution in the server's URL template."""

django_bolt/openapi/spec/server_variable.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .base import BaseSchemaObject
+
+__all__ = ("ServerVariable",)
+
+
+@dataclass
+class ServerVariable(BaseSchemaObject):
+    """An object representing a Server Variable for server URL template substitution."""
+
+    default: str
+    """**REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_
+    supplied. Note this behavior is different than the
+    `Schema Object's <https://spec.openapis.org/oas/v3.1.0#schemaObject>`_ treatment of default values, because in those
+    cases parameter values are optional.  If the `enum <https://spec.openapis.org/oas/v3.1.0#serverVariableEnum>`_ is
+    defined, the value MUST exist in the enum's values.
+    """
+
+    enum: list[str] | None = None
+    """An enumeration of string values to be used if the substitution options are from a limited set.
+
+    The array SHOULD NOT be empty.
+    """
+
+    description: str | None = None
+    """An optional description for the server variable.
+
+    `CommonMark syntax <https://spec.commonmark.org/>`_ MAY be used for rich text representation.
+    """

django_bolt/openapi/spec/tag.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from .base import BaseSchemaObject
+
+if TYPE_CHECKING:
+    from .external_documentation import ExternalDocumentation
+
+__all__ = ("Tag",)
+
+
+@dataclass
+class Tag(BaseSchemaObject):
+    """Adds metadata to a single tag that is used by the
+    `Operation Object <https://spec.openapis.org/oas/v3.1.0#operationObject>`_.
+
+    It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
+    """
+
+    name: str
+    """**REQUIRED**. The name of the tag."""
+
+    description: str | None = None
+    """A short description for the tag.
+
+    `CommonMark syntax <https://spec.commonmark.org/>`_ MAY be used for rich text representation.
+    """
+
+    external_docs: ExternalDocumentation | None = None
+    """Additional external documentation for this tag."""

django_bolt/openapi/spec/xml.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .base import BaseSchemaObject
+
+__all__ = ("XML",)
+
+
+@dataclass()
+class XML(BaseSchemaObject):
+    """A metadata object that allows for more fine-tuned XML model definitions.
+
+    When using arrays, XML element names are *not* inferred (for singular/plural forms) and the ``name`` property SHOULD
+    be used to add that information. See examples for expected behavior.
+    """
+
+    name: str | None = None
+    """
+    Replaces the name of the element/attribute used for the described schema property. When defined within ``items``, it
+    will affect the name of the individual XML elements within the list. When defined alongside ``type`` being ``array``
+    (outside the ``items``), it will affect the wrapping element and only if ``wrapped`` is ``True``. If ``wrapped`` is
+    ``False``, it will be ignored.
+    """
+
+    namespace: str | None = None
+    """The URI of the namespace definition. Value MUST be in the form of an absolute URI."""
+
+    prefix: str | None = None
+    """The prefix to be used for the
+    `xmlName <https://spec.openapis.org/oas/v3.1.0#xmlName>`_
+    """
+
+    attribute: bool = False
+    """Declares whether the property definition translates to an attribute instead of an element. Default value is
+    ``False``.
+    """
+
+    wrapped: bool = False
+    """
+    MAY be used only for an array definition. Signifies whether the array is wrapped (for example,
+    ``<books><book/><book/></books>``) or unwrapped (``<book/><book/>``). Default value is ``False``. The definition
+    takes effect only when defined alongside ``type`` being ``array`` (outside the ``items``).
+    """