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
In some situations, I was my test to be more descriptive, but I don't necessarily want my docs to have the same description. However, when I customize the description on the test level, the values set on the describe are lost. For example, the following test...
describeV1::MyController,openapi: {summary: 'Do the stuff that my controller does',tags: ["My tag"],}doit'returns a 200 status with a json body',openapi: {description: 'Success'}doget'v1/my'expect(response).tohave_http_status(:ok)expect(response.parsed_body).toeq(expected_response)endend
But I would expect it to output the following yaml
"/v1/my":
get:
summary: Do the stuff that my controller doestags:
- My tagresponses:
'200':
description: Successcontent:
application/json:
schema:
type: objectproperties:
...
The text was updated successfully, but these errors were encountered:
:openapi metadata is currently extracted only from it(...) blocks.
Supporting metadata in describe(...) block seems to make sense for tags (not sure for summary).
If someone want to contribute to this feature, metadata extraction can be found:
In some situations, I was my test to be more descriptive, but I don't necessarily want my docs to have the same description. However, when I customize the description on the test level, the values set on the describe are lost. For example, the following test...
produces the following yaml
But I would expect it to output the following yaml
The text was updated successfully, but these errors were encountered: