Class OpenApiGenerator

src/config_validator_function/openapi.py:24–441

}

class OpenApiGenerator:
    def _get_openapi_template_filename(self) -> str:
        return OPENAPI_TEMPLATE_FILE

    def _get_openapi_template(self) -> Dict:
        shell_filename = self._get_openapi_template_filename()
        logger.info('Loading openapi shell from %s', shell_filename)
        with open(shell_filename) as file:
            return json.loads(file.read())

    def generate(self, apis_config: Dict, apigw_host: str, cloudfront_host: str, auth_scheme: str) -> Dict:
        openapi = self._get_openapi_template()

        if "title" in apis_config:
            openapi["info"]["title"] = apis_config["title"]
        if "description" in apis_config:
            openapi["info"]["description"] = apis_config["description"]
        if "version" in apis_config:
            openapi["info"]["version"] = apis_config["version"]

        if cloudfront_host:
            openapi["servers"].append({ "url": cloudfront_host })
        openapi["servers"].append({ "url": apigw_host })

        if auth_scheme == AUTH_SCHEME_API_KEY:
            openapi["security"] = [ { "ApiKeyAuth": [] } ]
            openapi["components"]["securitySchemes"] = {
                "ApiKeyAuth": {
                    "type": "apiKey",
                    "in": "header",
                    "name": "X-API-Key"
                }
            }
        elif auth_scheme == AUTH_SCHEME_OAUTH2:
            openapi["security"] = [ { "BearerAuth": [] } ]
            openapi["components"]["securitySchemes"] = {
                "BearerAuth": {
                    "type": "http",
                    "scheme": "bearer",
                    "bearerFormat": "JWT"
                }#,
                #"OAuth2Auth": {
                #    "type": "oauth2",
                #    "flows": {
                #        "authorizationCode": {
                #            "authorizationUrl": "https://mydomain.auth.us-east-1.amazoncognito.com/oauth2/authorize",
                #            "tokenUrl": "https://mydomain.auth.us-east-1.amazoncognito.com/oauth2/token",
                #            "refreshUrl": "https://mydomain.auth.us-east-1.amazoncognito.com/oauth2/token"
                #        }
                #    }
                #}
            }
        else:
            openapi.pop("security", None)

        tags = []
        paths = {}