Skip to content

Schema object namespaces #578

Closed
Closed
@ikitommi

Description

@ikitommi

With 2.0, the schema object names in definitions clash easily. For example, there can be several User definitions in a codebase, and if all api-docs are squashed into a single open-api doc, those schema names will clash if there is no namespace information of the model.

I propose a guide and a promotion how to manage namespaces with Schemas. Simplest thing would be to advise using full namespaced names with schemas, e.g. myservice.reporting.User & mydomain.auth.User. Client libs would do this automatically and tools like swagger-ui (openapi-ui?) would render those nicely.

Currently, the ui works with full names, but long names break the layout. And the swagger.json examples & client libs seem to enforce just the short names without namespaces.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions