Define x-webhooks in API definitions
#156
Conversation
|
The preview build check was (and is) failing, but for some reason it is not being counted as a check anymore, and I can't trigger a preview build manually either. I'm still investigating. |
| requestBody: | ||
| $ref: ../components/schema/requestBodies/Webhooks/Customer.yaml | ||
| responses: | ||
| '200': |
There was a problem hiding this comment.
We accept any 200-series response. I think you can use 2XX with uppercase X:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#patterned-fields-1
There was a problem hiding this comment.
Same for all of the other webhook responses... (I won't leave the same comment everywhere)
…finitions into define-x-webhooks
Co-authored-by: Adam Altman <adam@rebilly.com>
|
I believe the build failure is unavoidable until this PR in Redoc is merged: Redocly/redoc#1304 Right now, @adamaltman to avoid build problems, should I hold off merging this PR until |
|
That shouldn’t be tied to build failure. |
|
Update- I reached out to Roman a couple days ago to help me investigate the build issues and the bug Adam reported, but he's got a lot of work right now and hasn't had a chance to get to it yet. |
|
@mathewsonke the issue is openapi-cli doesn't bundle the specification extensions. I opened this bug: Redocly/redocly-cli#174 (feel free to contribute there if you want to fix it ASAP... if not, it's okay. The solution may be in adjusting here (somewhere): https://github.com/Redocly/openapi-cli/blob/master/src/typings/openapi.ts |
…s into define-x-webhooks
Our webhooks can use any HTTP verb and they will provide the same information. The webhooks spec however does not appear to allow us to define webhooks which are verb-agnostic. For that reason I have defined all the webhooks as
post.