doc: Swagger for custom attribute APIs (#4382)

swagger/definitions/index.yml

@@ -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'
-    
-    
+
+
 

swagger/definitions/request/custom_attribute/create_update_payload.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)

swagger/definitions/resource/custom_attribute.yml

@@ -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