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
It is currently unclear whether the paths.<path>.<method>.responses.<status code>.description field describes the status code or the response body and if it's the status code where to describe the response body and vice versa.
For example both of these seem to be reasonable definitions:
paths:
/foo:
post:
summary: Create a new fooresponses:
202:
description: The foo has been received and will be processed within one minutecontent:
text/plain: {}
paths:
/foo:
post:
summary: Create a new fooresponses:
202:
description: A job token to inquire about the status of the processing of the foocontent:
text/plain: {}
In the OpenAPI Guide on swagger.io the Describing Responses page uses description to describe the response body, except in the section "HTTP Status Codes" where it is used to give a reason for the status code. (Unless I'm missing something and those are actually different description fields.)
paths:
/foo:
post:
summary: Create a new fooresponses:
202:
description: The foo has been received and will be processed within one minutecontent:
text/plain:
schema:
type: stringdescription: A job token to inquire about the status of the processing of the foo
Activity
AndreKR commentedon Jan 25, 2022
This might be the appropriate way?