We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
enumName
When using @ApiProperty like this:
@ApiProperty
@ApiProperty({ enum: SortOrder, default: SortOrder.DESC })
It renders the OpenAPI json like this:
{ "name": "order", "required": true, "in": "query", "schema": { "default": "DESC", "enum": [ "DESC", "ASC" ], "type": "string" } }
However, when adding a reference to the enum using enumName instead to avoid duplicate definitions like this:
@ApiProperty({ enum: SortOrder, default: SortOrder.DESC, enumName: 'SortOrder' })
It renders like this:
{ "name": "order", "required": true, "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }
Here we can see that the default property is lost.
default
Here is a discussion that explains a possible solution: OAI/OpenAPI-Specification#2948
No response
Improve user experience when using software like Postman, Swagger or similar
The text was updated successfully, but these errors were encountered:
Would you like to create a PR for this issue?
Sorry, something went wrong.
ref: https://swagger.io/docs/specification/using-ref/
In v3.1.0, it appears that you can define some sibling elements, but it still don't have default property. ref: https://spec.openapis.org/oas/v3.1.0#reference-object
OAI/OpenAPI-Specification#2948 In my opinion, the example in this page is no different than the code below.
@ApiProperty({ default: SortOrder.DESC, allOf: [ { $ref: getSchemaPath('SortOrder') }, ] })
@Eirmas , you are right, but the SortOrder schema has the default added there and it is being rendered in the swagger ui as well.
@kamilmysliwiec , I am looking to contribute, Is there any priority on the issues that I can start with?
No branches or pull requests
Is there an existing issue that is already proposing this?
Is your feature request related to a problem? Please describe it
When using
@ApiProperty
like this:It renders the OpenAPI json like this:
However, when adding a reference to the enum using
enumName
instead to avoid duplicate definitions like this:It renders like this:
Here we can see that the
default
property is lost.Describe the solution you'd like
Here is a discussion that explains a possible solution: OAI/OpenAPI-Specification#2948
Teachability, documentation, adoption, migration strategy
No response
What is the motivation / use case for changing the behavior?
Improve user experience when using software like Postman, Swagger or similar
The text was updated successfully, but these errors were encountered: