You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Currently, the JSDoc comments on the response type is used as description. However, it may not accurately represent the actual response description.
Example,
Describe the solution you'd like
It would be great if the description can be overwritten with local JDDoc ccomments.
Exxample,
delete: {
summary: "Delete a task",
description: "Delete a specific task by ID.",
path: {
/** The identifier of the task to delete */
id: number
},
responses: {
/** Task deleted */
204: "",
/** Invalid params */
400: ProblemDetails
/** Task not found */
404: ProblemDetails
}
}
For the example above, status 204 description is inserted correctly as seen in the screenshot above.
The text was updated successfully, but these errors were encountered:
It turns out that the descriptions are added but to the wrong location. It should be placed in the location as indicated in the arrows in the screenshot below.
Also, the schema under components already has its own description, thus does not need to be repeated.
In addition to that, swagger editor produces warning when description is included together with $ref.
Is your feature request related to a problem? Please describe.
Currently, the JSDoc comments on the response type is used as description. However, it may not accurately represent the actual response description.
Example,
Describe the solution you'd like
It would be great if the description can be overwritten with local JDDoc ccomments.
Exxample,
For the example above, status 204 description is inserted correctly as seen in the screenshot above.
The text was updated successfully, but these errors were encountered: