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>
61 lines
1.6 KiB
YAML
61 lines
1.6 KiB
YAML
type: object
|
|
properties:
|
|
additional_attributes:
|
|
type: object
|
|
description: The object containing additional attributes related to the contact
|
|
properties:
|
|
city:
|
|
type: string
|
|
description: City of the contact
|
|
country:
|
|
type: string
|
|
description: Country of the contact
|
|
country_code:
|
|
type: string
|
|
description: Country code of the contact
|
|
created_at_ip:
|
|
type: string
|
|
description: IP address when the contact was created
|
|
availability_status:
|
|
type: string
|
|
description: Availability status of the contact
|
|
enum: ["online", "offline"]
|
|
email:
|
|
type: string
|
|
description: The email address of the contact
|
|
nullable: true
|
|
id:
|
|
type: integer
|
|
description: The ID of the contact
|
|
name:
|
|
type: string
|
|
description: The name of the contact
|
|
phone_number:
|
|
type: string
|
|
description: The phone number of the contact
|
|
nullable: true
|
|
blocked:
|
|
type: boolean
|
|
description: Whether the contact is blocked
|
|
identifier:
|
|
type: string
|
|
description: The identifier of the contact
|
|
nullable: true
|
|
thumbnail:
|
|
type: string
|
|
description: The thumbnail of the contact
|
|
custom_attributes:
|
|
type: object
|
|
description: The custom attributes of the contact
|
|
last_activity_at:
|
|
type: integer
|
|
description: Timestamp of last activity
|
|
nullable: true
|
|
created_at:
|
|
type: integer
|
|
description: Timestamp when contact was created
|
|
contact_inboxes:
|
|
type: array
|
|
description: List of inboxes associated with this contact
|
|
items:
|
|
$ref: '#/components/schemas/contact_inbox' |