Webhooks (OAS 3.1) support

[vvarp]

Are there any plans to support webhooks field from OAS 3.1 spec?
It is like the last thing holding me off from migration :)

On a side note: I know project is pretty recent as compared to more established OpenAPI documentation tools, but it is amazing how much been achieved so far, and how you managed to keep it packed with features while staying on the side of simplicity and ease of use - well done!

[linear]

ZUP-4021 Webhooks (OAS 3.1) support

[dan-lee]

Thanks for your kind words, really appreciated 🙏

The webhooks feature is not directly on the roadmap, but we would of course like to support it. As we haven't explored it further yet, I'm interested in what you think it could look like on the API documentation page. Maybe it isn't too much effort after all

[vvarp]

Not sure what spec says exactly as I haven't dig into it too deeply, but what I'd expect is pretty much plain render of schema that's tied to specific type of webhook event.

To give a simplest example possible, here's a bit of a schema and how it renders out in redoc:

webhooks:
  RefundEvent:
    post:
      summary: Refund
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundEventPayload'
      responses:
        '200':
          description: No response body