Skip to content

Commit 93ef8b3

Browse files
jbrooksukgithub-actions[bot]
authored andcommitted
Generated API specification from cachethq/core@40da147
1 parent 6722f39 commit 93ef8b3

File tree

1 file changed

+151
-4
lines changed

1 file changed

+151
-4
lines changed

api-reference/openapi.json

Lines changed: 151 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"url": "http://localhost/api"
1111
},
1212
{
13-
"url": "https://v3.cachethq.io",
13+
"url": "https://v3.cachethq.io/api",
1414
"description": "The Cachet v3 demo server."
1515
}
1616
],
@@ -329,6 +329,9 @@
329329
}
330330
}
331331
},
332+
"403": {
333+
"$ref": "#/components/responses/MissingAbilityException"
334+
},
332335
"401": {
333336
"$ref": "#/components/responses/AuthenticationException"
334337
},
@@ -435,6 +438,9 @@
435438
}
436439
}
437440
},
441+
"403": {
442+
"$ref": "#/components/responses/MissingAbilityException"
443+
},
438444
"404": {
439445
"$ref": "#/components/responses/ModelNotFoundException"
440446
},
@@ -467,6 +473,9 @@
467473
"204": {
468474
"description": "No content"
469475
},
476+
"403": {
477+
"$ref": "#/components/responses/MissingAbilityException"
478+
},
470479
"404": {
471480
"$ref": "#/components/responses/ModelNotFoundException"
472481
},
@@ -645,6 +654,9 @@
645654
}
646655
}
647656
},
657+
"403": {
658+
"$ref": "#/components/responses/MissingAbilityException"
659+
},
648660
"401": {
649661
"$ref": "#/components/responses/AuthenticationException"
650662
},
@@ -751,6 +763,9 @@
751763
}
752764
}
753765
},
766+
"403": {
767+
"$ref": "#/components/responses/MissingAbilityException"
768+
},
754769
"404": {
755770
"$ref": "#/components/responses/ModelNotFoundException"
756771
},
@@ -783,6 +798,9 @@
783798
"204": {
784799
"description": "No content"
785800
},
801+
"403": {
802+
"$ref": "#/components/responses/MissingAbilityException"
803+
},
786804
"404": {
787805
"$ref": "#/components/responses/ModelNotFoundException"
788806
},
@@ -992,6 +1010,9 @@
9921010
}
9931011
}
9941012
},
1013+
"403": {
1014+
"$ref": "#/components/responses/MissingAbilityException"
1015+
},
9951016
"401": {
9961017
"$ref": "#/components/responses/AuthenticationException"
9971018
},
@@ -1098,6 +1119,9 @@
10981119
}
10991120
}
11001121
},
1122+
"403": {
1123+
"$ref": "#/components/responses/MissingAbilityException"
1124+
},
11011125
"404": {
11021126
"$ref": "#/components/responses/ModelNotFoundException"
11031127
},
@@ -1130,6 +1154,9 @@
11301154
"204": {
11311155
"description": "No content"
11321156
},
1157+
"403": {
1158+
"$ref": "#/components/responses/MissingAbilityException"
1159+
},
11331160
"404": {
11341161
"$ref": "#/components/responses/ModelNotFoundException"
11351162
},
@@ -1332,6 +1359,9 @@
13321359
}
13331360
}
13341361
},
1362+
"403": {
1363+
"$ref": "#/components/responses/MissingAbilityException"
1364+
},
13351365
"404": {
13361366
"$ref": "#/components/responses/ModelNotFoundException"
13371367
},
@@ -1459,6 +1489,9 @@
14591489
}
14601490
}
14611491
},
1492+
"403": {
1493+
"$ref": "#/components/responses/MissingAbilityException"
1494+
},
14621495
"404": {
14631496
"$ref": "#/components/responses/ModelNotFoundException"
14641497
},
@@ -1500,6 +1533,9 @@
15001533
"204": {
15011534
"description": "No content"
15021535
},
1536+
"403": {
1537+
"$ref": "#/components/responses/MissingAbilityException"
1538+
},
15031539
"404": {
15041540
"$ref": "#/components/responses/ModelNotFoundException"
15051541
},
@@ -1682,6 +1718,9 @@
16821718
}
16831719
}
16841720
},
1721+
"403": {
1722+
"$ref": "#/components/responses/MissingAbilityException"
1723+
},
16851724
"401": {
16861725
"$ref": "#/components/responses/AuthenticationException"
16871726
},
@@ -1780,6 +1819,9 @@
17801819
}
17811820
}
17821821
},
1822+
"403": {
1823+
"$ref": "#/components/responses/MissingAbilityException"
1824+
},
17831825
"404": {
17841826
"$ref": "#/components/responses/ModelNotFoundException"
17851827
},
@@ -1812,6 +1854,9 @@
18121854
"204": {
18131855
"description": "No content"
18141856
},
1857+
"403": {
1858+
"$ref": "#/components/responses/MissingAbilityException"
1859+
},
18151860
"404": {
18161861
"$ref": "#/components/responses/ModelNotFoundException"
18171862
},
@@ -2007,6 +2052,9 @@
20072052
}
20082053
}
20092054
},
2055+
"403": {
2056+
"$ref": "#/components/responses/MissingAbilityException"
2057+
},
20102058
"401": {
20112059
"$ref": "#/components/responses/AuthenticationException"
20122060
},
@@ -2114,6 +2162,9 @@
21142162
}
21152163
}
21162164
},
2165+
"403": {
2166+
"$ref": "#/components/responses/MissingAbilityException"
2167+
},
21172168
"404": {
21182169
"$ref": "#/components/responses/ModelNotFoundException"
21192170
},
@@ -2146,6 +2197,9 @@
21462197
"204": {
21472198
"description": "No content"
21482199
},
2200+
"403": {
2201+
"$ref": "#/components/responses/MissingAbilityException"
2202+
},
21492203
"404": {
21502204
"$ref": "#/components/responses/ModelNotFoundException"
21512205
},
@@ -2347,6 +2401,9 @@
23472401
}
23482402
}
23492403
},
2404+
"403": {
2405+
"$ref": "#/components/responses/MissingAbilityException"
2406+
},
23502407
"404": {
23512408
"$ref": "#/components/responses/ModelNotFoundException"
23522409
},
@@ -2449,6 +2506,9 @@
24492506
"204": {
24502507
"description": "No content"
24512508
},
2509+
"403": {
2510+
"$ref": "#/components/responses/MissingAbilityException"
2511+
},
24522512
"404": {
24532513
"$ref": "#/components/responses/ModelNotFoundException"
24542514
},
@@ -2651,6 +2711,9 @@
26512711
}
26522712
}
26532713
},
2714+
"403": {
2715+
"$ref": "#/components/responses/MissingAbilityException"
2716+
},
26542717
"401": {
26552718
"$ref": "#/components/responses/AuthenticationException"
26562719
},
@@ -2757,6 +2820,9 @@
27572820
}
27582821
}
27592822
},
2823+
"403": {
2824+
"$ref": "#/components/responses/MissingAbilityException"
2825+
},
27602826
"404": {
27612827
"$ref": "#/components/responses/ModelNotFoundException"
27622828
},
@@ -2789,6 +2855,9 @@
27892855
"204": {
27902856
"description": "No content"
27912857
},
2858+
"403": {
2859+
"$ref": "#/components/responses/MissingAbilityException"
2860+
},
27922861
"404": {
27932862
"$ref": "#/components/responses/ModelNotFoundException"
27942863
},
@@ -2984,6 +3053,9 @@
29843053
}
29853054
}
29863055
},
3056+
"403": {
3057+
"$ref": "#/components/responses/MissingAbilityException"
3058+
},
29873059
"404": {
29883060
"$ref": "#/components/responses/ModelNotFoundException"
29893061
},
@@ -3111,6 +3183,9 @@
31113183
}
31123184
}
31133185
},
3186+
"403": {
3187+
"$ref": "#/components/responses/MissingAbilityException"
3188+
},
31143189
"404": {
31153190
"$ref": "#/components/responses/ModelNotFoundException"
31163191
},
@@ -3152,6 +3227,9 @@
31523227
"204": {
31533228
"description": "No content"
31543229
},
3230+
"403": {
3231+
"$ref": "#/components/responses/MissingAbilityException"
3232+
},
31553233
"404": {
31563234
"$ref": "#/components/responses/ModelNotFoundException"
31573235
},
@@ -3311,6 +3389,29 @@
33113389
"human",
33123390
"string"
33133391
]
3392+
},
3393+
"pivot": {
3394+
"type": "object",
3395+
"properties": {
3396+
"component_status": {
3397+
"type": "object",
3398+
"properties": {
3399+
"human": {
3400+
"type": "string"
3401+
},
3402+
"value": {
3403+
"type": "string"
3404+
}
3405+
},
3406+
"required": [
3407+
"human",
3408+
"value"
3409+
]
3410+
}
3411+
},
3412+
"required": [
3413+
"component_status"
3414+
]
33143415
}
33153416
},
33163417
"required": [
@@ -3680,6 +3781,15 @@
36803781
"type": "null"
36813782
}
36823783
]
3784+
},
3785+
"components": {
3786+
"type": [
3787+
"array",
3788+
"null"
3789+
],
3790+
"items": {
3791+
"$ref": "#/components/schemas/IncidentComponentRequestData"
3792+
}
36833793
}
36843794
},
36853795
"required": [
@@ -3823,7 +3933,10 @@
38233933
"format": "date-time"
38243934
},
38253935
"completed_at": {
3826-
"type": "string",
3936+
"type": [
3937+
"string",
3938+
"null"
3939+
],
38273940
"format": "date-time"
38283941
},
38293942
"status": {
@@ -3849,8 +3962,7 @@
38493962
"required": [
38503963
"name",
38513964
"message",
3852-
"scheduled_at",
3853-
"completed_at"
3965+
"scheduled_at"
38543966
],
38553967
"title": "CreateScheduleRequestData"
38563968
},
@@ -4076,6 +4188,22 @@
40764188
],
40774189
"title": "Incident"
40784190
},
4191+
"IncidentComponentRequestData": {
4192+
"type": "object",
4193+
"properties": {
4194+
"id": {
4195+
"type": "integer"
4196+
},
4197+
"status": {
4198+
"$ref": "#/components/schemas/ComponentStatusEnum"
4199+
}
4200+
},
4201+
"required": [
4202+
"id",
4203+
"status"
4204+
],
4205+
"title": "IncidentComponentRequestData"
4206+
},
40794207
"IncidentIdentifier": {
40804208
"type": "object",
40814209
"properties": {
@@ -5093,6 +5221,25 @@
50935221
}
50945222
}
50955223
},
5224+
"MissingAbilityException": {
5225+
"description": "Authorization error",
5226+
"content": {
5227+
"application/json": {
5228+
"schema": {
5229+
"type": "object",
5230+
"properties": {
5231+
"message": {
5232+
"type": "string",
5233+
"description": "Error overview."
5234+
}
5235+
},
5236+
"required": [
5237+
"message"
5238+
]
5239+
}
5240+
}
5241+
}
5242+
},
50965243
"AuthenticationException": {
50975244
"description": "Unauthenticated",
50985245
"content": {

0 commit comments

Comments
 (0)