Replies: 1 comment
-
With respect to doing this with the Success attribute, I just saw that the documentation for @apiSuccess says 'You can set a title and description with @apiDefine.' Maybe I just don't have the syntax correct. Here is what I'm trying:
|
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hi,
I would like to be able to provide a description for the @apiBody section so that my description appears between the 'Request Body' header and the table. There are other sections I'd like to be able to do the same for (like Success, Error, etc), but the most frequent is the Body.
So I would like to see:
Body Title
Some description here about the body
| Field | Type | Description |
| field1 | boolean | Description about field1 specifically |
Is there some way that this can be done using the available apidoc attributes?
Another scenario is where my API response with a 200 OK, but there is no body in the response. I would like to be able to provided a description about the scenario that would provide that response and elaborate more about what that response means.
Beta Was this translation helpful? Give feedback.
All reactions