Skip to content

Commit 84479af

Browse files
Update OpenAPI spec
1 parent 175bc6a commit 84479af

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

site/static/mattermost-openapi-v4.yaml

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21329,8 +21329,8 @@ paths:
2132921329
value:
2133021330
channel_id: 4xp9fdt77pncbef59f4k1qe83o
2133121331
cursor: ""
21332-
per_page: 100
2133321332
start_time: 1635638400000
21333+
per_page: 100
2133421334
descending_order:
2133521335
summary: Descending order from recent
2133621336
value:
@@ -21371,19 +21371,19 @@ paths:
2137121371
message: First post
2137221372
create_at: 1635638400000
2137321373
post_id_2:
21374-
message: Second post
2137521374
create_at: 1635638500000
2137621375
id: post_id_2
21376+
message: Second post
2137721377
next_cursor:
2137821378
cursor: MTphYmMxMjM6Y3JlYXRlX2F0OmZhbHNlOmZhbHNlOmFzYzoxNjM1NjM4NTAwMDAwOnBvc3RfaWRfMg
2137921379
last_page:
2138021380
summary: Last page (no more results)
2138121381
value:
2138221382
posts:
2138321383
post_id_99:
21384-
id: post_id_99
2138521384
message: Last post
2138621385
create_at: 1635724800000
21386+
id: post_id_99
2138721387
"400":
2138821388
$ref: '#/components/responses/BadRequest'
2138921389
"401":
@@ -23637,9 +23637,9 @@ paths:
2363723637
type: string
2363823638
description: The name of the playbook run.
2363923639
example: Server down in EU cluster
23640-
description:
23640+
summary:
2364123641
type: string
23642-
description: The description of the playbook run.
23642+
description: The summary of the playbook run.
2364323643
example: There is one server in the EU cluster that is not responding since April 12.
2364423644
owner_user_id:
2364523645
type: string
@@ -23663,7 +23663,7 @@ paths:
2366323663
curl -X POST 'http://localhost:8065/plugins/playbooks/api/v0/runs' \
2366423664
-H 'Authorization: Bearer 9g64ig7q9pds8yjz8rsgd6e36e'\
2366523665
-H 'Content-Type: application/json'\
23666-
-d '{"name": "Server down in EU cluster", "description": "There is one server in the EU cluster that is not responding since April 12.", "owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg", "team_id": "61ji2mpflefup3cnuif80r5rde", "playbook_id": "0y4a0ntte97cxvfont8y84wa7x"}'
23666+
-d '{"name": "Server down in EU cluster", "summary": "There is one server in the EU cluster that is not responding since April 12.", "owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg", "team_id": "61ji2mpflefup3cnuif80r5rde", "playbook_id": "0y4a0ntte97cxvfont8y84wa7x"}'
2366723667
responses:
2366823668
"201":
2366923669
description: Created playbook run.
@@ -24028,15 +24028,22 @@ paths:
2402824028
properties:
2402924029
name:
2403024030
type: string
24031-
description: The new name of the playbook run.
24031+
description: The new name of the playbook run. Must not be empty.
2403224032
example: Updated Server Down Incident
24033+
summary:
24034+
type: string
24035+
description: The new summary of the playbook run. Can be empty to clear the summary.
24036+
example: |-
24037+
## Incident Summary
24038+
24039+
Resolved the server outage.
2403324040
x-codeSamples:
2403424041
- lang: curl
2403524042
source: |
2403624043
curl -X PATCH 'http://localhost:8065/plugins/playbooks/api/v0/runs/mx3xyzdojfgyfdx8sc8of1gdme' \
2403724044
-H 'Authorization: Bearer 9g64ig7q9pds8yjz8rsgd6e36e'\
2403824045
-H 'Content-Type: application/json'\
24039-
-d '{"name": "Updated Server Down Incident"}'
24046+
-d '{"name": "Updated Server Down Incident", "summary": "## Summary\n\nResolved the server outage."}'
2404024047
responses:
2404124048
"200":
2404224049
description: Playbook run successfully updated.
@@ -24458,7 +24465,7 @@ paths:
2445824465
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}:
2445924466
put:
2446024467
summary: Update an item of a playbook run's checklist
24461-
description: Update the title and the slash command of an item in one of the playbook run's checklists.
24468+
description: Update the title, slash command, and description of an item in one of the playbook run's checklists.
2446224469
operationId: itemRename
2446324470
security:
2446424471
- BearerAuth: []
@@ -24501,6 +24508,10 @@ paths:
2450124508
type: string
2450224509
description: The new slash command of the item.
2450324510
example: /jira update ticket
24511+
description:
24512+
type: string
24513+
description: The new description of the item, formatted with Markdown.
24514+
example: Ask the customer for more information in [Zendesk](https://www.zendesk.com/).
2450424515
required:
2450524516
- title
2450624517
- command
@@ -24509,7 +24520,7 @@ paths:
2450924520
source: |
2451024521
curl -X PUT 'http://localhost:8065/plugins/playbooks/api/v0/runs/6t7jdgyqr7b5sk24zkauhmrb06/checklists/1/item/0' \
2451124522
-H 'Authorization: Bearer 9g64ig7q9pds8yjz8rsgd6e36e'\
24512-
-d '{"title": "Gather information from server's logs.", "command": "/jira update ticket"}'
24523+
-d '{"title": "Gather information from server's logs.", "command": "/jira update ticket", "description": "Ask the customer for more information in [Zendesk](https://www.zendesk.com/)."}'
2451324524
responses:
2451424525
"200":
2451524526
description: Item updated.
@@ -26254,8 +26265,8 @@ components:
2625426265
description: Additional attributes for the property field (options for select fields, visibility, etc.).
2625526266
additionalProperties: true
2625626267
example:
26257-
sortOrder: 1
2625826268
visibility: when_set
26269+
sortOrder: 1
2625926270
options:
2626026271
- color: '#ff0000'
2626126272
id: opt1
@@ -30511,9 +30522,9 @@ components:
3051130522
type: string
3051230523
description: The name of the playbook run.
3051330524
example: Server down in EU cluster
30514-
description:
30525+
summary:
3051530526
type: string
30516-
description: The description of the playbook run.
30527+
description: The summary of the playbook run.
3051730528
example: There is one server in the EU cluster that is not responding since April 12.
3051830529
is_active:
3051930530
type: boolean

0 commit comments

Comments
 (0)