doc: Swagger for custom attribute APIs (#4382)
This commit is contained in:
Muhsin Keloth
GitHub
parent
d4a046a21e
commit
dfb56f6bb8
11 changed files with 453 additions and 3 deletions
|
|
@ -14,6 +14,8 @@ generic_id:
|
|||
$ref: ./resource/extension/generic.yml
|
||||
canned_response:
|
||||
$ref: ./resource/canned_response.yml
|
||||
custom_attribute:
|
||||
$ref: ./resource/custom_attribute.yml
|
||||
contact:
|
||||
$ref: ./resource/contact.yml
|
||||
conversation:
|
||||
|
|
@ -69,6 +71,8 @@ user_create_update_payload:
|
|||
canned_response_create_update_payload:
|
||||
$ref: ./request/canned_response/create_update_payload.yml
|
||||
|
||||
custom_attribute_create_update_payload:
|
||||
$ref: ./request/custom_attribute/create_update_payload.yml
|
||||
## contact
|
||||
contact_create:
|
||||
$ref: ./request/contact/create.yml
|
||||
|
|
@ -154,6 +158,6 @@ account_summary:
|
|||
$ref: './resource/reports/summary.yml'
|
||||
agent_conversation_metrics:
|
||||
$ref: './resource/reports/conversation/agent.yml'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
type: object
|
||||
properties:
|
||||
attribute_display_name:
|
||||
type: string
|
||||
description: Attribute display name
|
||||
attribute_display_type:
|
||||
type: integer
|
||||
description: Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)
|
||||
attribute_description:
|
||||
type: string
|
||||
description: Attribute description
|
||||
attribute_key:
|
||||
type: string
|
||||
description: Attribute unique key value
|
||||
attribute_values:
|
||||
type: array
|
||||
description: Attribute values
|
||||
items:
|
||||
type: string
|
||||
attribute_model:
|
||||
type: integer
|
||||
description: Attribute type(conversation_attribute- 0, contact_attribute- 1)
|
||||
29
swagger/definitions/resource/custom_attribute.yml
Normal file
29
swagger/definitions/resource/custom_attribute.yml
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
description: Identifier
|
||||
attribute_display_name:
|
||||
type: string
|
||||
description: Attribute display name
|
||||
attribute_display_type:
|
||||
type: string
|
||||
description: Attribute display type (text, number, currency, percent, link, date, list, checkbox)
|
||||
attribute_description:
|
||||
type: string
|
||||
description: Attribute description
|
||||
attribute_key:
|
||||
type: string
|
||||
description: Attribute unique key value
|
||||
attribute_values:
|
||||
type: string
|
||||
description: Attribute values
|
||||
default_value:
|
||||
type: string
|
||||
description: Attribute default value
|
||||
attribute_model:
|
||||
type: string
|
||||
description: Attribute type(conversation_attribute/contact_attribute)
|
||||
account_id:
|
||||
type: integer
|
||||
description: Account Id
|
||||
|
|
@ -66,6 +66,7 @@ x-tagGroups:
|
|||
- Teams
|
||||
- Custom Filters
|
||||
- Reports
|
||||
- Custom Attributes
|
||||
- name: Client
|
||||
tags:
|
||||
- Contacts API
|
||||
|
|
|
|||
20
swagger/paths/application/custom_attributes/create.yml
Normal file
20
swagger/paths/application/custom_attributes/create.yml
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
tags:
|
||||
- Custom Attributes
|
||||
operationId: add-new-custom-attribute-to-account
|
||||
summary: Add a new custom attribute
|
||||
description: Add a new custom attribute to account
|
||||
security:
|
||||
- userApiKey: []
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/custom_attribute_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/custom_attribute'
|
||||
403:
|
||||
description: Access denied
|
||||
20
swagger/paths/application/custom_attributes/delete.yml
Normal file
20
swagger/paths/application/custom_attributes/delete.yml
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
tags:
|
||||
- Custom Attributes
|
||||
operationId: delete-custom-attribute-from-account
|
||||
summary: Remove a custom attribute from account
|
||||
description: Remove a custom attribute from account
|
||||
security:
|
||||
- userApiKey: []
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
type: integer
|
||||
required: true
|
||||
description: The ID of the custom attribute to be deleted
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
404:
|
||||
description: Custom attribute not found
|
||||
403:
|
||||
description: Access denied
|
||||
24
swagger/paths/application/custom_attributes/index.yml
Normal file
24
swagger/paths/application/custom_attributes/index.yml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
tags:
|
||||
- Custom Attributes
|
||||
operationId: get-account-custom-attribute
|
||||
summary: List all custom attributes in an account
|
||||
parameters:
|
||||
- name: attribute_model
|
||||
in: query
|
||||
type: string
|
||||
enum: ['0', '1']
|
||||
description: conversation_attribute(0)/contact_attribute(1)
|
||||
required: true
|
||||
description: Get details of custom attributes in an Account
|
||||
security:
|
||||
- userApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of all custom attributes'
|
||||
items:
|
||||
$ref: '#/definitions/custom_attribute'
|
||||
403:
|
||||
description: Access denied
|
||||
14
swagger/paths/application/custom_attributes/show.yml
Normal file
14
swagger/paths/application/custom_attributes/show.yml
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
tags:
|
||||
- Custom Attributes
|
||||
operationId: get-details-of-a-single-custom-attribute
|
||||
summary: Get a custom attribute details
|
||||
description: Get the details of a custom attribute in the account
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/custom_attribute'
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The given attribute ID does not exist in the account
|
||||
28
swagger/paths/application/custom_attributes/update.yml
Normal file
28
swagger/paths/application/custom_attributes/update.yml
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
tags:
|
||||
- Custom Attributes
|
||||
operationId: update-custom-attribute-in-account
|
||||
summary: Update custom attribute in Account
|
||||
description: Update a custom attribute in account
|
||||
security:
|
||||
- userApiKey: []
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
type: integer
|
||||
required: true
|
||||
description: The ID of the custom attribute to be updated.
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/custom_attribute_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
description: 'The updated custom attribute'
|
||||
$ref: '#/definitions/custom_attribute'
|
||||
404:
|
||||
description: Agent not found
|
||||
403:
|
||||
description: Access denied
|
||||
|
|
@ -170,6 +170,24 @@
|
|||
delete:
|
||||
$ref: ./application/canned_responses/delete.yml
|
||||
|
||||
# Custom Attributes
|
||||
/api/v1/accounts/{account_id}/custom_attribute_definitions:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/custom_attributes/index.yml
|
||||
post:
|
||||
$ref: ./application/custom_attributes/create.yml
|
||||
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
get:
|
||||
$ref: './application/custom_attributes/show.yml'
|
||||
patch:
|
||||
$ref: ./application/custom_attributes/update.yml
|
||||
delete:
|
||||
$ref: ./application/custom_attributes/delete.yml
|
||||
|
||||
# Contacts
|
||||
/api/v1/accounts/{account_id}/contacts:
|
||||
$ref: ./application/contacts/list_create.yml
|
||||
|
|
|
|||
|
|
@ -1494,6 +1494,202 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/accounts/{account_id}/custom_attribute_definitions": {
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/parameters/account_id"
|
||||
}
|
||||
],
|
||||
"get": {
|
||||
"tags": [
|
||||
"Custom Attributes"
|
||||
],
|
||||
"operationId": "get-account-custom-attribute",
|
||||
"summary": "List all custom attributes in an account",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "attribute_model",
|
||||
"in": "query",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"0",
|
||||
"1"
|
||||
],
|
||||
"description": "conversation_attribute(0)/contact_attribute(1)",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"description": "Get details of custom attributes in an Account",
|
||||
"security": [
|
||||
{
|
||||
"userApiKey": [
|
||||
|
||||
]
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"description": "Array of all custom attributes",
|
||||
"items": {
|
||||
"$ref": "#/definitions/custom_attribute"
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Access denied"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"tags": [
|
||||
"Custom Attributes"
|
||||
],
|
||||
"operationId": "add-new-custom-attribute-to-account",
|
||||
"summary": "Add a new custom attribute",
|
||||
"description": "Add a new custom attribute to account",
|
||||
"security": [
|
||||
{
|
||||
"userApiKey": [
|
||||
|
||||
]
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/custom_attribute_create_update_payload"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/custom_attribute"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Access denied"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}": {
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/parameters/account_id"
|
||||
}
|
||||
],
|
||||
"get": {
|
||||
"tags": [
|
||||
"Custom Attributes"
|
||||
],
|
||||
"operationId": "get-details-of-a-single-custom-attribute",
|
||||
"summary": "Get a custom attribute details",
|
||||
"description": "Get the details of a custom attribute in the account",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/custom_attribute"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized"
|
||||
},
|
||||
"404": {
|
||||
"description": "The given attribute ID does not exist in the account"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"tags": [
|
||||
"Custom Attributes"
|
||||
],
|
||||
"operationId": "update-custom-attribute-in-account",
|
||||
"summary": "Update custom attribute in Account",
|
||||
"description": "Update a custom attribute in account",
|
||||
"security": [
|
||||
{
|
||||
"userApiKey": [
|
||||
|
||||
]
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"type": "integer",
|
||||
"required": true,
|
||||
"description": "The ID of the custom attribute to be updated."
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/custom_attribute_create_update_payload"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/custom_attribute"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Agent not found"
|
||||
},
|
||||
"403": {
|
||||
"description": "Access denied"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"tags": [
|
||||
"Custom Attributes"
|
||||
],
|
||||
"operationId": "delete-custom-attribute-from-account",
|
||||
"summary": "Remove a custom attribute from account",
|
||||
"description": "Remove a custom attribute from account",
|
||||
"security": [
|
||||
{
|
||||
"userApiKey": [
|
||||
|
||||
]
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "id",
|
||||
"type": "integer",
|
||||
"required": true,
|
||||
"description": "The ID of the custom attribute to be deleted"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success"
|
||||
},
|
||||
"404": {
|
||||
"description": "Custom attribute not found"
|
||||
},
|
||||
"403": {
|
||||
"description": "Access denied"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/v1/accounts/{account_id}/contacts": {
|
||||
"get": {
|
||||
"tags": [
|
||||
|
|
@ -4058,6 +4254,47 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"custom_attribute": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "Identifier"
|
||||
},
|
||||
"attribute_display_name": {
|
||||
"type": "string",
|
||||
"description": "Attribute display name"
|
||||
},
|
||||
"attribute_display_type": {
|
||||
"type": "string",
|
||||
"description": "Attribute display type (text, number, currency, percent, link, date, list, checkbox)"
|
||||
},
|
||||
"attribute_description": {
|
||||
"type": "string",
|
||||
"description": "Attribute description"
|
||||
},
|
||||
"attribute_key": {
|
||||
"type": "string",
|
||||
"description": "Attribute unique key value"
|
||||
},
|
||||
"attribute_values": {
|
||||
"type": "string",
|
||||
"description": "Attribute values"
|
||||
},
|
||||
"default_value": {
|
||||
"type": "string",
|
||||
"description": "Attribute default value"
|
||||
},
|
||||
"attribute_model": {
|
||||
"type": "string",
|
||||
"description": "Attribute type(conversation_attribute/contact_attribute)"
|
||||
},
|
||||
"account_id": {
|
||||
"type": "integer",
|
||||
"description": "Account Id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"contact": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -4718,6 +4955,38 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"custom_attribute_create_update_payload": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"attribute_display_name": {
|
||||
"type": "string",
|
||||
"description": "Attribute display name"
|
||||
},
|
||||
"attribute_display_type": {
|
||||
"type": "integer",
|
||||
"description": "Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)"
|
||||
},
|
||||
"attribute_description": {
|
||||
"type": "string",
|
||||
"description": "Attribute description"
|
||||
},
|
||||
"attribute_key": {
|
||||
"type": "string",
|
||||
"description": "Attribute unique key value"
|
||||
},
|
||||
"attribute_values": {
|
||||
"type": "array",
|
||||
"description": "Attribute values",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"attribute_model": {
|
||||
"type": "integer",
|
||||
"description": "Attribute type(conversation_attribute- 0, contact_attribute- 1)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"contact_create": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
|
|
@ -5449,7 +5718,8 @@
|
|||
"Profile",
|
||||
"Teams",
|
||||
"Custom Filters",
|
||||
"Reports"
|
||||
"Reports",
|
||||
"Custom Attributes"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in a new issue