Function test_schema_generation

tests/test_schemas.py:133–188

()

def test_schema_generation() -> None:
    schema = schemas.get_schema(routes=app.routes)
    assert schema == {
        "openapi": "3.0.0",
        "info": {"title": "Example API", "version": "1.0"},
        "paths": {
            "/orgs": {
                "get": {
                    "responses": {
                        200: {
                            "description": "A list of organisations.",
                            "examples": [{"name": "Foo Corp."}, {"name": "Acme Ltd."}],
                        }
                    }
                },
                "post": {
                    "responses": {
                        200: {
                            "description": "An organisation.",
                            "examples": {"name": "Foo Corp."},
                        }
                    }
                },
            },
            "/regular-docstring-and-schema": {
                "get": {"responses": {200: {"description": "This is included in the schema."}}}
            },
            "/subapp/subapp-endpoint": {
                "get": {"responses": {200: {"description": "This endpoint is part of a subapp."}}}
            },
            "/subapp2/subapp-endpoint": {
                "get": {"responses": {200: {"description": "This endpoint is part of a subapp."}}}
            },
            "/users": {
                "get": {
                    "responses": {
                        200: {
                            "description": "A list of users.",
                            "examples": [{"username": "tom"}, {"username": "lucy"}],
                        }
                    }
                },
                "post": {"responses": {200: {"description": "A user.", "examples": {"username": "tom"}}}},
            },
            "/users/{id}": {
                "get": {
                    "responses": {
                        200: {
                            "description": "A user.",
                            "examples": {"username": "tom"},
                        }
                    }
                },
            },
        },
    }