chore: Swagger documentation for public APIs (#2417)
This commit is contained in:
20
swagger/paths/public/inboxes/contacts/create.yml
Normal file
20
swagger/paths/public/inboxes/contacts/create.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: create-a-contact
|
||||
summary: Create a contact
|
||||
description: Create a contact
|
||||
security:
|
||||
- nil
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/public_contact_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/public_contact'
|
||||
401:
|
||||
description: Unauthorized
|
||||
16
swagger/paths/public/inboxes/contacts/show.yml
Normal file
16
swagger/paths/public/inboxes/contacts/show.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: get-details-of-a-contact
|
||||
summary: Get a contact
|
||||
description: Get the details of a contact
|
||||
security:
|
||||
- nil
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/public_contact'
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The given contact does not exist
|
||||
20
swagger/paths/public/inboxes/contacts/update.yml
Normal file
20
swagger/paths/public/inboxes/contacts/update.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: update-a-contact
|
||||
summary: Update a contact
|
||||
description: Update a contact's attributes
|
||||
security:
|
||||
- nil
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/public_contact_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/public_contact'
|
||||
401:
|
||||
description: Unauthorized
|
||||
Reference in New Issue
Block a user