Class OpenAPI

robyn/openapi.py:204–706

This is the root object of the OpenAPI document. @param info: OpenAPIInfo Provides metadata about the API. @param openapi_spec: dict The content of openapi.json as a dict

@dataclass
class OpenAPI:
    """
    This is the root object of the OpenAPI document.

    @param info: OpenAPIInfo Provides metadata about the API.
    @param openapi_spec: dict The content of openapi.json as a dict
    """

    info: OpenAPIInfo = field(default_factory=OpenAPIInfo)
    openapi_spec: dict = field(init=False)
    openapi_file_override: bool = False  # denotes whether there is an override or not.

    def __post_init__(self):
        """
        Initializes the openapi_spec dict
        """
        if self.openapi_file_override:
            return

        self.openapi_spec = {
            "openapi": "3.1.0",
            "info": asdict(self.info),
            "paths": {},
            "components": asdict(self.info.components),
            "servers": [asdict(server) for server in self.info.servers],
            "externalDocs": asdict(self.info.externalDocs) if self.info.externalDocs.url else None,
        }

    def add_security_scheme(self, name: str, scheme: dict) -> None:
        """Register a reusable security scheme (e.g. Bearer/API-key auth).

        Populating ``components.securitySchemes`` is what makes Swagger UI's
        "Authorize" button appear and work; without it the button is either
        absent or opens an empty popup (see #1122, #1339).

        @param name: str the key under ``components.securitySchemes`` (e.g. ``"BearerAuth"``).
        @param scheme: dict the OpenAPI Security Scheme Object, e.g.
            ``{"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}``.
        """
        if self.openapi_file_override:
            return
        self.openapi_spec["components"].setdefault("securitySchemes", {})[name] = scheme

    @property
    def _security_scheme_names(self) -> list[str]:
        return list(self.openapi_spec.get("components", {}).get("securitySchemes", {}) or {})

    def prune_empty_components(self) -> None:
        """Drop empty ``components`` buckets so the generated spec stays clean.

        In particular an empty ``securitySchemes: {}`` makes Swagger UI render an
        empty "Available authorizations" popup; omitting it removes the button
        entirely until the user actually configures a scheme (#1122, #1339).
        """
        if self.openapi_file_override:
            return
        components = self.openapi_spec.get("components")
        if isinstance(components, dict):