mirror of
https://github.com/lingble/chatwoot.git
synced 2026-03-20 03:52:43 +00:00
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>
79 lines
1.5 KiB
YAML
79 lines
1.5 KiB
YAML
type: object
|
|
properties:
|
|
id:
|
|
type: number
|
|
access_token:
|
|
type: string
|
|
account_id:
|
|
type: number
|
|
available_name:
|
|
type: string
|
|
avatar_url:
|
|
type: string
|
|
confirmed:
|
|
type: boolean
|
|
display_name:
|
|
type: string
|
|
nullable: true
|
|
message_signature:
|
|
type: string
|
|
nullable: true
|
|
email:
|
|
type: string
|
|
hmac_identifier:
|
|
type: string
|
|
inviter_id:
|
|
type: number
|
|
name:
|
|
type: string
|
|
provider:
|
|
type: string
|
|
pubsub_token:
|
|
type: string
|
|
role:
|
|
type: string
|
|
enum: ['agent', 'administrator']
|
|
ui_settings:
|
|
type: object
|
|
uid:
|
|
type: string
|
|
type:
|
|
type: string
|
|
nullable: true
|
|
custom_attributes:
|
|
type: object
|
|
description: Available for users who are created through platform APIs and has custom attributes associated.
|
|
accounts:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: number
|
|
name:
|
|
type: string
|
|
status:
|
|
type: string
|
|
active_at:
|
|
type: string
|
|
format: date-time
|
|
role:
|
|
type: string
|
|
enum: ['administrator', 'agent']
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
availability:
|
|
type: string
|
|
availability_status:
|
|
type: string
|
|
auto_offline:
|
|
type: boolean
|
|
custom_role_id:
|
|
type: number
|
|
nullable: true
|
|
custom_role:
|
|
type: object
|
|
nullable: true
|