-
Notifications
You must be signed in to change notification settings - Fork 9.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Schema object namespaces #578
Comments
We might consider this as optional but ensure that client generators and UIs support it. Previously we were not specific about the name of models in the definitions, and saw stuff like high-level characters. |
+1 OData Schema object names an fully qualified with namespaces using dot notation. This seems to work fine in Swagger UI, Swagger Editor, and the validators I tried, so I assumed that most/all tools support it. |
With 2.0, the schema object names in
definitions
clash easily. For example, there can be severalUser
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.
The text was updated successfully, but these errors were encountered: