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

@@ -4,16 +4,22 @@ operationId: create-a-contact
summary: Create a contact
description: Create a contact
security: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/public_contact_create_update_payload'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/public_contact_create_update_payload'
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/public_contact'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/public_contact'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -5,11 +5,21 @@ summary: Get a contact
description: Get the details of a contact
security: []
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/public_contact'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/public_contact'
'401':
description: Unauthorized
404:
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'
'404':
description: The given contact does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -4,16 +4,22 @@ operationId: update-a-contact
summary: Update a contact
description: Update a contact's attributes
security: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/public_contact_create_update_payload'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/public_contact_create_update_payload'
responses:
200:
'200':
description: Success
schema:
$ref: '#/definitions/public_contact'
401:
content:
application/json:
schema:
$ref: '#/components/schemas/public_contact'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'