chore: Swagger documentation for contact labels APIs (#8279)
Co-authored-by: Sojan Jose <sojan@pepalo.com>
This commit is contained in:
26
swagger/paths/application/contacts/labels/create.yml
Normal file
26
swagger/paths/application/contacts/labels/create.yml
Normal file
@@ -0,0 +1,26 @@
|
||||
tags:
|
||||
- Contact Labels
|
||||
operationId: contact-add-labels
|
||||
summary: Add Labels
|
||||
description: Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
labels:
|
||||
type: array
|
||||
description: Array of labels (comma-separated strings)
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/contact_labels'
|
||||
404:
|
||||
description: Contact not found
|
||||
401:
|
||||
description: Unauthorized
|
||||
14
swagger/paths/application/contacts/labels/index.yml
Normal file
14
swagger/paths/application/contacts/labels/index.yml
Normal file
@@ -0,0 +1,14 @@
|
||||
tags:
|
||||
- Contact Labels
|
||||
operationId: list-all-labels-of-a-contact
|
||||
summary: List Labels
|
||||
description: Lists all the labels of a contact
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/contact_labels'
|
||||
404:
|
||||
description: Contact not found
|
||||
401:
|
||||
description: Unauthorized
|
||||
@@ -121,6 +121,14 @@
|
||||
- $ref: '#/parameters/message_id'
|
||||
patch:
|
||||
$ref: ./public/inboxes/messages/update.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{contact_identifier}/labels:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
get:
|
||||
$ref: ./application/contacts/labels/index.yml
|
||||
post:
|
||||
$ref: ./application/contacts/labels/create.yml
|
||||
|
||||
# ---------------- end of public api routes-----------#
|
||||
|
||||
|
||||
Reference in New Issue
Block a user