chore: Update API docs (#1153)

This commit is contained in:
Pranav Raj S
2020-08-18 12:14:37 +05:30
committed by GitHub
parent dfe4b70d91
commit 662bb882f7
11 changed files with 259 additions and 6 deletions
+22
View File
@@ -0,0 +1,22 @@
get:
tags:
- Contact
operationId: contactSearch
description: Search the contacts using a search key, currently supports email search
summary: Search Contacts
parameters:
- name: q
in: query
type: string
responses:
200:
description: Success
schema:
type: object
properties:
payload:
$ref: '#/definitions/contact_list'
401:
description: Authentication error
schema:
$ref: '#/definitions/bad_request_error'
+21
View File
@@ -0,0 +1,21 @@
post:
tags:
- Contact
operationId: contactInboxCreation
description: Create a contact inbox record for an inbox
summary: Create contact inbox
parameters:
- name: inbox_id
in: params
type: number
responses:
200:
description: Success
schema:
$ref: '#/definitions/contact_inboxes'
401:
description: Authentication error
schema:
$ref: '#/definitions/bad_request_error'
422:
description: Incorrect payload
+14
View File
@@ -1,5 +1,6 @@
# Inboxes
/accounts/{account_id}/inboxes:
$ref: ./inboxes/index.yml
@@ -34,7 +35,20 @@
# Contacts
/accounts/{account_id}/contacts:
$ref: ./contact/list_create.yml
/accounts/{account_id}/contacts/{id}:
$ref: ./contact/crud.yml
/accounts/{account_id}/contacts/{id}/conversations:
$ref: ./contact/conversations.yml
/accounts/{account_id}/contacts/search:
$ref: ./contact/search.yml
/accounts/{account_id}/contacts/{id}/contact_inboxes:
$ref: ./contact_inboxes/create.yml
# Profile
/profile:
$ref: ./profile/index.yml
+13
View File
@@ -0,0 +1,13 @@
get:
tags:
- Profile
operationId: fetchProfile
summary: Fetch user profile
description: Get the user profile details
responses:
200:
description: Success
schema:
$ref: '#/definitions/user'
401:
description: Unauthorized