Added ability to set name for ApiResponse and RequestBody annotations #4861
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is now possible to specify the name of any component using an annotation, except for RequestBody and ApiResponse. The name of the components is required not only for the linear description of the specification, but also so that these components can be taken out to the #/components/ block.
The idea is to add a new annotation in which the user can describe common components and then refer to these components.
In other words, the RequestBody and ApiResponse annotations currently have a
ref
field to reference the component, but there is no way to add this component to the #/components/ blockMy idea is to add an OpenAPIComponents annotation something like this:
To allow the code to describe common components, and add annotations with references to common components to methods / fields / parameters