Swagger as TypedDict (WIP)

openapi.py

import typing


class InfoFragment(typing.TypedDict):

    title: str
    version: str


OptionalInAttribute = typing.TypedDict(
    'OptionalInAttribute', {'in': str}
)

RefFragment = typing.TypedDict('RefFragment', {'$ref': str})

class RequiredParameterFragment(typing.TypedDict):
    name: str
    type: str


class ParameterFragment(RequiredParameterFragment, OptionalInAttribute):
    ...


class ResponseFragment(typing.TypedDict):
    
    description: str
    schema: typing.Union[RefFragment]

class _OptionalOperationFragment(typing.TypedDict, total=False):
    parameters: typing.List[typing.Union[ParameterFragment, RefFragment]]


class _RequiredOperationFragment(typing.TypedDict):
    responses: typing.Mapping[str, ResponseFragment]


class OperationFragment(_RequiredOperationFragment, _OptionalOperationFragment):
    operationId: str


class _OptionalPathFragment(typing.TypedDict, total=False):
    parameters: typing.List[typing.Union[ParameterFragment, RefFragment]]

    delete: OperationFragment
    patch: OperationFragment
    post: OperationFragment
    put: OperationFragment

class _RequredPathFragment(typing.TypedDict):
    ...


class PathFragment(_OptionalPathFragment, _RequredPathFragment, total=False):
    get: OperationFragment


class OpenApiDocument(typing.TypedDict):

    info: InfoFragment
    paths: typing.Mapping[str, PathFragment]

data = {
    "info": {
        "title": "Hello",
        "version": "1.0",
    },
    "paths": {
        "/things": {
            "parameters": [
                {
                    "name": "filter",
                    "in": "query",
                    "type": "str"
                },
                {
                    "$ref": "#/parameters/apiversion"
                }
            ],
            "get": {
                "operationId": "Something something...",
                "responses": {
                    "200": {
                        "description": "Ok",
                        "schema": {
                            "$ref": "#/definitions/ThingPaged"
                        }
                    }
                }
            }
        },
        "/things/{thingId}": {
            "get": {
                "operationId": "Something else...",
                "responses":{}
            }
        }
    }
}
swagger: OpenApiDocument = {
    "info": {
        "title": "Hello",
        "version": "1.0",
    },
    "paths": {
        "/things": {
            "parameters": [
                {
                    "name": "filter",
                    "in": "query",
                    "type": "str"
                },
                {
                    "$ref": "#/parameters/apiversion"
                }
            ],
            "get": {
                "operationId": "Something something...",
                "responses": {
                    "200": {
                        "description": "Ok",
                        "schema": {
                            "$ref": "#/definitions/ThingPaged"
                        }
                    }
                }
            }
        },
        "/things/{thingId}": {
            "get": {
                "operationId": "Something else...",
                "smurf": "<<--- This will give you uggly squigglies!",
                "responses":{}
            }
        }
    }
}