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

@@ -5,34 +5,47 @@ post:
description: Create a contact inbox record for an inbox
summary: Create contact inbox
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/components/parameters/account_id'
- name: id
in: path
type: number
schema:
type: number
description: ID of the contact
required: true
- name: data
in: body
required: true
schema:
type: object
required:
- inbox_id
properties:
inbox_id:
type: number
description: The ID of the inbox
source_id:
type: string
description: Contact Inbox Source Id
security:
- userApiKey: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- inbox_id
properties:
inbox_id:
type: number
description: The ID of the inbox
example: 1
source_id:
type: string
description: Contact Inbox Source Id
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/contact_inboxes'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/contact_inboxes'
'401':
description: Authentication error
schema:
$ref: '#/definitions/bad_request_error'
422:
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'422':
description: Incorrect payload
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'