mirror of
https://github.com/lingble/chatwoot.git
synced 2025-12-25 15:17:02 +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>
39 lines
1.0 KiB
YAML
39 lines
1.0 KiB
YAML
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Identifier
|
|
attribute_display_name:
|
|
type: string
|
|
description: Attribute display name
|
|
attribute_display_type:
|
|
type: string
|
|
description: Attribute display type (text, number, currency, percent, link, date, list, checkbox)
|
|
attribute_description:
|
|
type: string
|
|
description: Attribute description
|
|
attribute_key:
|
|
type: string
|
|
description: Attribute unique key value
|
|
regex_pattern:
|
|
type: string
|
|
description: Regex pattern
|
|
regex_cue:
|
|
type: string
|
|
description: Regex cue
|
|
attribute_values:
|
|
type: string
|
|
description: Attribute values
|
|
attribute_model:
|
|
type: string
|
|
description: Attribute type(conversation_attribute/contact_attribute)
|
|
default_value:
|
|
type: string
|
|
description: Attribute default value
|
|
created_at:
|
|
type: string
|
|
description: The date and time when the custom attribute was created
|
|
updated_at:
|
|
type: string
|
|
description: The date and time when the custom attribute was updated
|