chore: Swagger documentation for contact labels APIs (#8279)

Co-authored-by: Sojan Jose <sojan@pepalo.com>
This commit is contained in:
Muhsin Keloth
2023-11-03 15:09:12 +05:30
committed by GitHub
parent 36b6c0cb9c
commit ebe9daea00
7 changed files with 145 additions and 1 deletions

View 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

View 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