Support Webhook operationId output when explicitly passed #1438
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this commit, providing
operation_idtoextend_schemaon a webhook object would not have any effect on the resulting schema.The OpenAPI 3.1 spec added support for webhooks being their own top-level definition. Each Webhook is an Operation Object.
Operation Objects are defined in the spec @ 4.8.10, and it dictates that they may contain an
operationedIdstring field:Some platforms, such as Fern docs, require
operationIdon webhooks in the schema to identify them. Without the ability to output operationId users cannot use their schema with services like this.We took the decision to only output explicitly provided operationIds for two reasons: