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
According to OpenAPI 3.x, request body of a POST operation is defined in the requestBody field of the operation. This isn't supported by OIS, which may cause confusion while using it.
The reasoning behind this decision was that the requestBody schema was too complex (to support any kind of a request body schema), yet the POST operations of most APIs require a non-nested JSON body. Furthermore, these operations typically do not have query parameters (in addition to the request body). As a hacky solution, we decided that in:query for POST operations are to be mapped to the request body (https://docs.api3.org/reference/ois/latest/specification.html#_4-2-1-2-in). This has three downsides:
We don't support query parameters for POST operations (hasn't been a problem thus far)
It confuses the readers of the spec. For example, @hiletmis was tripped up by this while building a frontend that makes calls for testing signed API pusher integrations.
I figured the least we can do is to leave an issue here
The text was updated successfully, but these errors were encountered:
According to OpenAPI 3.x, request body of a POST operation is defined in the
requestBody
field of the operation. This isn't supported by OIS, which may cause confusion while using it.The reasoning behind this decision was that the
requestBody
schema was too complex (to support any kind of a request body schema), yet the POST operations of most APIs require a non-nested JSON body. Furthermore, these operations typically do not have query parameters (in addition to the request body). As a hacky solution, we decided thatin
:query
for POST operations are to be mapped to the request body (https://docs.api3.org/reference/ois/latest/specification.html#_4-2-1-2-in). This has three downsides:I figured the least we can do is to leave an issue here
The text was updated successfully, but these errors were encountered: