Skip to content

generators#

SortingOpenAPISchemaGenerator#

Bases: OpenAPISchemaGenerator

Schema generator that sorts definitions list by key.

Source code in src/apps/common/generators.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
class SortingOpenAPISchemaGenerator(OpenAPISchemaGenerator):
    """Schema generator that sorts definitions list by key."""

    def get_schema(self, request=None, public=False):
        schema = super().get_schema(request, public)

        # Sort model definitions
        schema.definitions = {key: schema.definitions[key] for key in sorted(schema.definitions)}

        # Remove the / path from swagger
        schema.paths.pop("/", None)

        return schema