Source code for flask_ligand.views.openapi

"""OpenAPI helper resources."""

# ======================================================================================================================
# Imports
# ======================================================================================================================
from __future__ import annotations
import flask_ligand
from flask import current_app
from typing import TYPE_CHECKING
from flask.views import MethodView
from flask_ligand.extensions.api import Blueprint
from flask_ligand.controllers import get_openapi_client_dl_link
from flask_ligand.schemas import OpenApiClientDownloadRespSchema, OpenApiClientDownloadQueryArgsSchema


# ======================================================================================================================
# Type Checking
# ======================================================================================================================
if TYPE_CHECKING:  # pragma: no cover
    from typing import Mapping, Any

# ======================================================================================================================
# Globals
# ======================================================================================================================
BLP = Blueprint(
    "OpenAPI Client Generator",
    __name__,
    url_prefix="/openapi",
    description="Provides download links to pre-configured OpenAPI clients for this service.",
)


# ======================================================================================================================
# Classes: Public
# ======================================================================================================================
@BLP.route("/typescript-axios/")
class OpenApiTypescriptAxios(MethodView):
    @BLP.arguments(OpenApiClientDownloadQueryArgsSchema, location="query")
    @BLP.response(200, OpenApiClientDownloadRespSchema)
    def get(self, args: Mapping[str, Any]) -> Any:
        """
        Generate a 'typescript-axios' OpenAPI client for this service.

        **NOTE**: The link provided is only good for one download before it expires!

        See for more details: https://openapi-generator.tech/docs/generators
        """

        options = {
            "npmName": current_app.config["OPENAPI_CLIENT_NAME"],
            "npmVersion": flask_ligand.__version__,
            "supportsES6": True,
            "useSingleRequestParameter": True,
        }

        use_private_url = args.get("use_private_url", True)

        return OpenApiClientDownloadRespSchema().dump(
            get_openapi_client_dl_link(
                current_app,
                use_private_url,
                "typescript-axios",
                options,
            )
        )


@BLP.route("/python/")
class OpenApiPython(MethodView):
    @BLP.arguments(OpenApiClientDownloadQueryArgsSchema, location="query")
    @BLP.response(200, OpenApiClientDownloadRespSchema)
    def get(self, args: Mapping[str, Any]) -> Any:
        """
        Generate a 'python' OpenAPI client for this service.

        **NOTE**: The link provided is only good for one download before it expires!

        See for more details: https://openapi-generator.tech/docs/generators
        """

        options = {
            "packageName": current_app.config["OPENAPI_CLIENT_NAME"].replace("-", "_"),
            "projectName": current_app.config["OPENAPI_CLIENT_NAME"],
            "packageVersion": flask_ligand.__version__,
        }

        use_private_url = args.get("use_private_url", True)

        return OpenApiClientDownloadRespSchema().dump(
            get_openapi_client_dl_link(
                current_app,
                use_private_url,
                "python",
                options,
            )
        )