Switch read-only and write-only behaviour in callbacks and webhooks

[gherkz]

Currently, RapiDoc hides read-only fields in requests and hides write-only fields in responses.

However, this behavior is the wrong way round for callbacks and webhooks, since the request is a "read" and the response is a "write". An obvious example of how this is the wrong way round would be an object with an ID field getting POSTed to a webhook:

{
    "id": 123,
    ...
}

Under the current behaviour, the ID field is hidden in the docs for requests that gets sent to a webhook or callback. Of course we would actually send the ID field.

Redoc had the same issue: Redocly/redoc#1720. It looks like they solved it by correcting the behavior and adding a new setting to switch back to the old behavior if desired.

If you can think of any workarounds for this in the meantime, then please do share! Looking to add a webhook to my API, and would prefer not to have an awkward comment in the description that says "the ID will be there, even though the docs don't mention it" 😄

PS - Related Issue swagger-api/swagger-ui#6294

[mrin9]

closed by 375935e

Thanks for the PR @gherkz

[gherkz]

No problem. IMO, rapidoc is the best solution out there over redoc and swagger UI - keep up the great work.