feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)

swagger/definitions/request/contact/create_payload.yml

@@ -0,0 +1,44 @@
+type: object
+required:
+  - inbox_id
+properties:
+  inbox_id:
+    type: number
+    description: ID of the inbox to which the contact belongs
+    example: 1
+  name:
+    type: string
+    description: name of the contact
+    example: Alice
+  email:
+    type: string
+    description: email of the contact
+    example: alice@acme.inc
+  blocked:
+    type: boolean
+    description: whether the contact is blocked or not
+    example: false
+  phone_number:
+    type: string
+    description: phone number of the contact
+    example: '+123456789'
+  avatar:
+    type: string
+    format: binary
+    description: Send the form data with the avatar image binary or use the avatar_url
+  avatar_url:
+    type: string
+    description: The url to a jpeg, png file for the contact avatar
+    example: https://example.com/avatar.png
+  identifier:
+    type: string
+    description: A unique identifier for the contact in external system
+    example: '1234567890'
+  additional_attributes:
+    type: object
+    description: An object where you can store additional attributes for contact. example {"type":"customer", "age":30}
+    example: { 'type': 'customer', 'age': 30 }
+  custom_attributes:
+    type: object
+    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.
+    example: {}

swagger/definitions/request/contact/update.yml

@@ -1,25 +0,0 @@
-type: object
-properties:
-  name:
-    type: string
-    description: name of the contact
-  email:
-    type: string
-    description: email of the contact
-  phone_number:
-    type: string
-    description: phone number of the contact
-  avatar:
-    type: string
-    format: binary
-    description: Send the form data with the avatar image binary or use the avatar_url
-  avatar_url:
-    type: string
-    description: The url to a jpeg, png file for the contact avatar
-  identifier:
-    type: string
-    description: A unique identifier for the contact in external system
-  custom_attributes:
-    type: object
-    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}
-

swagger/definitions/request/contact/update_payload.yml

@@ -1,18 +1,21 @@
 type: object
-required:
-  - inbox_id
 properties:
-  inbox_id:
-    type: number
   name:
     type: string
     description: name of the contact
+    example: Alice
   email:
     type: string
     description: email of the contact
+    example: alice@acme.inc
+  blocked:
+    type: boolean
+    description: whether the contact is blocked or not
+    example: false
   phone_number:
     type: string
     description: phone number of the contact
+    example: '+123456789'
   avatar:
     type: string
     format: binary
@@ -20,9 +23,16 @@ properties:
   avatar_url:
     type: string
     description: The url to a jpeg, png file for the contact avatar
+    example: https://example.com/avatar.png
   identifier:
     type: string
     description: A unique identifier for the contact in external system
+    example: '1234567890'
+  additional_attributes:
+    type: object
+    description: An object where you can store additional attributes for contact. example {"type":"customer", "age":30}
+    example: { 'type': 'customer', 'age': 30 }
   custom_attributes:
     type: object
-    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}
+    description: An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.
+    example: {}