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
There should be an indicator for a required request body.
Furthermore, I suggest that to avoid confusion, optional request bodies are labelled explicitly as optional (perhaps only when adding an explicit requried: false?). This is because it's easy to confuse whether the request body is required with whether the attributes of a top-level object is required. For example:
As rendered, I would expect the API to require a request body containing an object with the data attribute. However, the API requires EITHER an empty request body OR an object with the data attribute. An explicit optional indicator at the request body level could alleviate this confusion.
The text was updated successfully, but these errors were encountered:
Currently, the
requestBody
'srequired
attribute is not rendered:There should be an indicator for a required request body.
Furthermore, I suggest that to avoid confusion, optional request bodies are labelled explicitly as optional (perhaps only when adding an explicit
requried: false
?). This is because it's easy to confuse whether the request body is required with whether the attributes of a top-level object is required. For example:As rendered, I would expect the API to require a request body containing an object with the
data
attribute. However, the API requires EITHER an empty request body OR an object with thedata
attribute. An explicitoptional
indicator at the request body level could alleviate this confusion.The text was updated successfully, but these errors were encountered: