Created
September 9, 2024 14:37
-
-
Save browniebroke/5b7c5be806ae36e95232768ff04cefd6 to your computer and use it in GitHub Desktop.
Demo webhook OpenAPI schema
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.1.0 | |
info: | |
title: Demo | |
components: | |
schemas: | |
Event: | |
type: object | |
properties: | |
field_1: | |
type: string | |
readOnly: true | |
field_2: | |
type: string | |
securitySchemes: | |
tokenAuth: | |
type: apiKey | |
in: header | |
name: Authorization | |
description: Token-based authentication with required prefix "Token" | |
webhooks: | |
Event created: | |
post: | |
description: An event was created. | |
summary: An event was created. | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Event' | |
required: true | |
responses: | |
'200': | |
description: 'Return a 200 status to indicate that the data was received successfully.' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment