feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)

This commit is contained in:
Daniel Jimenez
2025-05-22 19:26:44 +12:00
committed by GitHub
parent 8697a30dc5
commit 4b417ce9e7
189 changed files with 10098 additions and 5847 deletions

View File

@@ -2,16 +2,28 @@ tags:
- Integrations
operationId: get-details-of-all-integrations
summary: List all the Integrations
security:
- userApiKey: []
description: Get the details of all Integrations available for the account
responses:
200:
'200':
description: Success
schema:
type: array
description: 'Array of Integration apps'
items:
$ref: '#/definitions/integrations_app'
401:
content:
application/json:
schema:
type: array
description: 'Array of Integration apps'
items:
$ref: '#/components/schemas/integrations_app'
'401':
description: Unauthorized
404:
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: Url not found
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -3,17 +3,26 @@ tags:
operationId: create-an-integration-hook
summary: Create an integration hook
description: Create an integration hook
security:
- userApiKey: []
parameters:
- $ref: '#/parameters/account_id'
- name: data
in: body
required: true
schema:
$ref: '#/definitions/integrations_hook_create_payload'
- $ref: '#/components/parameters/account_id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/integrations_hook_create_payload'
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/integrations_hook'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/integrations_hook'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -1,15 +1,25 @@
tags:
- Integrations
- Integrations
operationId: delete-an-integration-hook
summary: Delete an Integration Hook
description: Delete an Integration Hook
security:
- userApiKey: []
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/hook_id'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/hook_id'
responses:
200:
'200':
description: Success
401:
'401':
description: Unauthorized
404:
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: The hook does not exist in the account
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -3,18 +3,27 @@ tags:
operationId: update-an-integrations-hook
summary: Update an Integration Hook
description: Update an Integration Hook
security:
- userApiKey: []
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/hook_id'
- name: data
in: body
required: true
schema:
$ref: '#/definitions/integrations_hook_update_payload'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/hook_id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/integrations_hook_update_payload'
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/integrations_hook'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/integrations_hook'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'