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

# Pull Request Template

## Description

Updates the public swagger spec to be OpenAPI 3.0.4 compliant. Regarding
#7893, I'm investigating the use of
[oas_rails](https://github.com/a-chacon/oas_rails) to auto-generate the
documentation along with correct expected payloads.
Mostly fixes #10531, related to #7893

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality not to work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?

Copied spec into swagger editor, reviewed outputs:

![openapi](https://github.com/user-attachments/assets/bd43f895-74bb-4373-ba6d-c5b190b699dd)

Note that this shows two errors with the `DELETE` endpoints as
technically these should not have a `requestBody` - in which case we
should be making use of another HTTP verb or another endpoint.

## Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented on my code, particularly in hard-to-understand
areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] Any dependent changes have been merged and published in downstream
modules

---------

Co-authored-by: Daniel Jimenez <devildan.knex@gmail.com>
Co-authored-by: Daniel Jimenez <daniel.jimenez@spark64.com>

swagger/index.yml

@@ -34,7 +34,61 @@ components:
       in: header
       name: api_access_token
       description: This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
-
+tags:
+  - name: Accounts
+    description: Account management APIs
+  - name: Account Users
+    description: Account user management APIs
+  - name: AgentBots
+    description: Bot integrations
+  - name: Users
+    description: User management APIs
+  - name: Account AgentBots
+    description: Account-specific Agent Bots
+  - name: Agents
+    description: Agent management APIs
+  - name: Canned Responses
+    description: Pre-defined responses for common queries
+  - name: Contacts
+    description: Contact management APIs
+  - name: Contact Labels
+    description: Manage contact labels
+  - name: Conversation Assignments
+    description: Manage conversation assignments
+  - name: Conversation Labels
+    description: Manage conversation labels
+  - name: Conversations
+    description: Conversation management APIs
+  - name: Custom Attributes
+    description: Custom fields for contacts and conversations
+  - name: Custom Filters
+    description: Saved filters for conversations
+  - name: Inboxes
+    description: Communication channels setup
+  - name: Integrations
+    description: Third-party integrations
+  - name: Messages
+    description: Message management APIs
+  - name: Profile
+    description: User profile APIs
+  - name: Reports
+    description: Analytics and reporting APIs
+  - name: Teams
+    description: Team management APIs
+  - name: Webhooks
+    description: Event notification webhooks
+  - name: Automation Rule
+    description: Workflow automation rules
+  - name: Help Center
+    description: Knowledge base management
+  - name: Contacts API
+    description: Public contact APIs
+  - name: Conversations API
+    description: Public conversation APIs
+  - name: Messages API
+    description: Public message APIs
+  - name: CSAT Survey Page
+    description: Customer satisfaction survey
 x-tagGroups:
   - name: Platform
     tags:
@@ -48,6 +102,9 @@ x-tagGroups:
       - Agents
       - Canned Responses
       - Contacts
+      - Contact Labels
+      - Conversation Assignments
+      - Conversation Labels
       - Conversations
       - Custom Attributes
       - Custom Filters