[FERN-SCRIBE] Document Webhook support in openapi 3.1 #327
Description
📝 What do you want Fern Scribe (AI Technical Writer) to do?
Fern supports Webhooks as part of openapi 3.1, we need to document that.
🔗 Link to existing Slack thread
📋 Do you know of any documentation that needs to be updated?
https://buildwithfern.com/learn/openapi-definition/extensions/webhooks
https://buildwithfern.com/learn/docs/api-references/generate-webhook-reference
❌ If yes, describe why that documentation is incorrect
Current docs dont have documentation for openapi 3.1 where webhooks were introduced.
📰 Changelog Update Required
- Yes, include changelog entry
- No changelog needed
📎 Additional Context
we currently support the OpenAPI 3.1 webhooks! For example in the openapi you referenced. You can use it directly if you add an operationId to each webhook operation:
webhooks:
Each webhook needs a name
newPet:
# This is a Path Item Object, the only difference is that the request is initiated by the API provider
post:
operationId: newPetWebhook
requestBody:
description: Information about a new pet in the system
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully