feat(rulesets): add oas3_1-servers-in-webhook and oas3_1-callbacks-in… #2581
Conversation
packages/rulesets/src/oas/index.ts
Outdated
| message: 'Servers should not be defined in a webhook.', | ||
| formats: [oas3_1], | ||
| recommended: true, | ||
| given: ['$.webhooks.servers'], |
There was a problem hiding this comment.
i think we want this inside of the webhook operation, not at the webhooks object
There was a problem hiding this comment.
Ohhh okay servers can be defined on both. Should the warning only be at the webhook operation level?
There was a problem hiding this comment.
I'm reading through the oas docs and it seems like we should be showing a warning at both levels (the servers array at the path item object level would apply to all operations and servers at the operation level is for that operation only)
There was a problem hiding this comment.
Ok added that here fb14f54
| recommended: true, | ||
| given: ['$.webhooks[*][*].callbacks'], | ||
| then: { | ||
| function: undefined, |
There was a problem hiding this comment.
Are you referring to the function: undefined part? That function is checking if callbacks is undefined and if it's not then it'll show the warning.
kaylachun
force-pushed
the
feat/rulesets/oas3_1-webhooks
branch
from
cea7030
to
0f2b9a4
Compare
P0lip
force-pushed
the
develop
branch
3 times, most recently
from
dc90b7a
to
c22f408
Compare
…-webhook rules
Fixes #[ISSUE_NUMBER].
Checklist
Does this PR introduce a breaking change?
Screenshots
If applicable, add screenshots or gifs to help demonstrate the changes. If not applicable, remove this screenshots section before creating the PR.
Additional context
Added two new spectral rules: