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>
54 lines
1.5 KiB
YAML
54 lines
1.5 KiB
YAML
tags:
|
|
- Automation Rule
|
|
operationId: get-details-of-a-single-automation-rule
|
|
summary: Get a automation rule details
|
|
description: Get the details of a automation rule in the account
|
|
security:
|
|
- userApiKey: []
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
required: true
|
|
description: The ID of the automation rule to be updated.
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/automation_rule'
|
|
example:
|
|
payload:
|
|
id: 90
|
|
account_id: 1
|
|
name: "add-label-bug-if-message-contains-bug"
|
|
description: "add-label-bug-if-message-contains-bug"
|
|
event_name: "message_created"
|
|
conditions:
|
|
- values: ["incoming"]
|
|
attribute_key: "message_type"
|
|
query_operator: "and"
|
|
filter_operator: "equal_to"
|
|
- values: ["bug"]
|
|
attribute_key: "content"
|
|
filter_operator: "contains"
|
|
actions:
|
|
- action_name: "add_label"
|
|
action_params: ["bugs", "support-query"]
|
|
created_on: 1650555440
|
|
active: true
|
|
'401':
|
|
description: Unauthorized
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
'404':
|
|
description: The given rule ID does not exist in the account
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|