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

swagger/paths/application/contacts/crud.yml

@@ -1,58 +1,94 @@
 parameters:
-  - $ref: '#/parameters/account_id'
+  - $ref: '#/components/parameters/account_id'
   - name: id
     in: path
-    type: number
-    description: ID of the contact
     required: true
+    schema:
+      type: number
+    description: ID of the contact
 
 get:
   tags:
     - Contacts
   operationId: contactDetails
   summary: Show Contact
+  security:
+    - userApiKey: []
   description: Get a contact belonging to the account using ID
   responses:
-    200:
+    '200':
       description: Success
-      schema:
-        $ref: '#/definitions/extended_contact'
-    404:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/extended_contact'
+    '404':
       description: Contact not found
-    403:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
       description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
 
 put:
   tags:
     - Contacts
   operationId: contactUpdate
   summary: Update Contact
+  security:
+    - userApiKey: []
   description: Update a contact belonging to the account using ID
-  parameters:
-    - name: data
-      in: body
-      required: true
-      schema:
-        $ref: '#/definitions/contact_update'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/contact_update_payload'
   responses:
-    204:
+    '204':
       description: Success
-      schema:
-        $ref: '#/definitions/contact_base'
-    404:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/contact_base'
+    '404':
       description: Contact not found
-    403:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
       description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
 
 delete:
   tags:
     - Contacts
   operationId: contactDelete
   summary: Delete Contact
+  security:
+    - userApiKey: []
+  description: Delete a contact belonging to the account using ID
   responses:
-    200:
+    '200':
       description: Success
-    401:
+    '401':
       description: Unauthorized
-    404:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '404':
       description: Contact not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'