459f225559
# 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:  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>
55 lines
1.5 KiB
YAML
55 lines
1.5 KiB
YAML
type: object
|
|
properties:
|
|
labels:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Labels associated with the conversation
|
|
additional_attributes:
|
|
type: object
|
|
properties:
|
|
browser:
|
|
type: object
|
|
properties:
|
|
device_name:
|
|
type: string
|
|
description: Name of the device
|
|
browser_name:
|
|
type: string
|
|
description: Name of the browser
|
|
platform_name:
|
|
type: string
|
|
description: Name of the platform
|
|
browser_version:
|
|
type: string
|
|
description: Version of the browser
|
|
platform_version:
|
|
type: string
|
|
description: Version of the platform
|
|
referer:
|
|
type: string
|
|
description: Referrer URL
|
|
initiated_at:
|
|
type: object
|
|
properties:
|
|
timestamp:
|
|
type: string
|
|
description: Timestamp when the conversation was initiated
|
|
browser_language:
|
|
type: string
|
|
description: Browser language setting
|
|
conversation_language:
|
|
type: string
|
|
description: Conversation language
|
|
description: Additional attributes of the conversation
|
|
contact:
|
|
$ref: '#/components/schemas/contact_detail'
|
|
description: Contact details
|
|
agent_last_seen_at:
|
|
type: string
|
|
description: Timestamp when the agent last saw the conversation
|
|
nullable: true
|
|
assignee_last_seen_at:
|
|
type: string
|
|
description: Timestamp when the assignee last saw the conversation
|
|
nullable: true |