Skip to content

Commit 750e505

Browse files
OAS Update
1 parent 09c6205 commit 750e505

File tree

3 files changed

+1010
-0
lines changed

3 files changed

+1010
-0
lines changed

services/logme/v1/logme.json

Lines changed: 340 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
{
22
"components": {
33
"parameters": {
4+
"backupId": {
5+
"description": "Backup id",
6+
"in": "path",
7+
"name": "backupId",
8+
"required": true,
9+
"schema": {
10+
"type": "integer"
11+
}
12+
},
413
"instanceId": {
514
"description": "Instance id",
615
"in": "path",
@@ -82,6 +91,27 @@
8291
],
8392
"type": "object"
8493
},
94+
"CreateBackupResponse": {
95+
"items": {
96+
"$ref": "#/components/schemas/CreateBackupResponseItem"
97+
},
98+
"type": "array"
99+
},
100+
"CreateBackupResponseItem": {
101+
"properties": {
102+
"id": {
103+
"type": "integer"
104+
},
105+
"message": {
106+
"type": "string"
107+
}
108+
},
109+
"required": [
110+
"id",
111+
"message"
112+
],
113+
"type": "object"
114+
},
85115
"CreateInstancePayload": {
86116
"properties": {
87117
"instanceName": {
@@ -421,6 +451,11 @@
421451
},
422452
"groks": {
423453
"items": {
454+
"properties": {
455+
"pattern": {
456+
"type": "string"
457+
}
458+
},
424459
"type": "object"
425460
},
426461
"type": "array"
@@ -580,6 +615,20 @@
580615
],
581616
"type": "object"
582617
},
618+
"ListRestoresResponse": {
619+
"properties": {
620+
"instanceRestores": {
621+
"items": {
622+
"$ref": "#/components/schemas/Restore"
623+
},
624+
"type": "array"
625+
}
626+
},
627+
"required": [
628+
"instanceRestores"
629+
],
630+
"type": "object"
631+
},
583632
"Object": {
584633
"type": "object"
585634
},
@@ -683,6 +732,32 @@
683732
],
684733
"type": "object"
685734
},
735+
"Restore": {
736+
"properties": {
737+
"backup_id": {
738+
"type": "integer"
739+
},
740+
"finished_at": {
741+
"type": "string"
742+
},
743+
"id": {
744+
"type": "integer"
745+
},
746+
"status": {
747+
"type": "string"
748+
},
749+
"triggered_at": {
750+
"type": "string"
751+
}
752+
},
753+
"required": [
754+
"id",
755+
"backup_id",
756+
"status",
757+
"finished_at"
758+
],
759+
"type": "object"
760+
},
686761
"Schema": {
687762
"properties": {
688763
"parameters": {
@@ -693,6 +768,36 @@
693768
"parameters"
694769
],
695770
"type": "object"
771+
},
772+
"TriggerRestoreResponse": {
773+
"properties": {
774+
"id": {
775+
"type": "integer"
776+
}
777+
},
778+
"required": [
779+
"id"
780+
],
781+
"type": "object"
782+
},
783+
"UpdateBackupsConfigPayload": {
784+
"properties": {
785+
"encryption_key": {
786+
"type": "string"
787+
}
788+
},
789+
"type": "object"
790+
},
791+
"UpdateBackupsConfigResponse": {
792+
"properties": {
793+
"message": {
794+
"type": "string"
795+
}
796+
},
797+
"required": [
798+
"message"
799+
],
800+
"type": "object"
696801
}
697802
}
698803
},
@@ -936,6 +1041,148 @@
9361041
}
9371042
},
9381043
"summary": "get latest backup information for provided instanceId"
1044+
},
1045+
"post": {
1046+
"operationId": "CreateBackup",
1047+
"parameters": [
1048+
{
1049+
"$ref": "#/components/parameters/instanceId"
1050+
},
1051+
{
1052+
"$ref": "#/components/parameters/projectId"
1053+
}
1054+
],
1055+
"responses": {
1056+
"201": {
1057+
"content": {
1058+
"application/json": {
1059+
"schema": {
1060+
"$ref": "#/components/schemas/CreateBackupResponse"
1061+
}
1062+
}
1063+
},
1064+
"description": "Created"
1065+
},
1066+
"404": {
1067+
"$ref": "#/components/responses/NotFound"
1068+
},
1069+
"500": {
1070+
"$ref": "#/components/responses/ServerError"
1071+
}
1072+
},
1073+
"summary": "create a backup"
1074+
}
1075+
},
1076+
"/v1/projects/{projectId}/instances/{instanceId}/backups-config": {
1077+
"patch": {
1078+
"description": "Update the configuration for backups for your instance.",
1079+
"operationId": "UpdateBackupsConfig",
1080+
"parameters": [
1081+
{
1082+
"$ref": "#/components/parameters/instanceId"
1083+
},
1084+
{
1085+
"$ref": "#/components/parameters/projectId"
1086+
}
1087+
],
1088+
"requestBody": {
1089+
"content": {
1090+
"application/json": {
1091+
"schema": {
1092+
"$ref": "#/components/schemas/UpdateBackupsConfigPayload"
1093+
}
1094+
}
1095+
},
1096+
"description": "Parameters for the requested backup configuration update",
1097+
"required": true
1098+
},
1099+
"responses": {
1100+
"200": {
1101+
"content": {
1102+
"application/json": {
1103+
"schema": {
1104+
"$ref": "#/components/schemas/UpdateBackupsConfigResponse"
1105+
}
1106+
}
1107+
},
1108+
"description": "OK"
1109+
},
1110+
"404": {
1111+
"$ref": "#/components/responses/NotFound"
1112+
},
1113+
"500": {
1114+
"$ref": "#/components/responses/ServerError"
1115+
}
1116+
},
1117+
"summary": "backups configuration update"
1118+
}
1119+
},
1120+
"/v1/projects/{projectId}/instances/{instanceId}/backups/{backupId}/download": {
1121+
"get": {
1122+
"operationId": "DownloadBackup",
1123+
"parameters": [
1124+
{
1125+
"$ref": "#/components/parameters/backupId"
1126+
},
1127+
{
1128+
"$ref": "#/components/parameters/instanceId"
1129+
},
1130+
{
1131+
"$ref": "#/components/parameters/projectId"
1132+
}
1133+
],
1134+
"responses": {
1135+
"200": {
1136+
"content": {
1137+
"application/octet-stream": {
1138+
"schema": {
1139+
"format": "binary",
1140+
"type": "string"
1141+
}
1142+
}
1143+
},
1144+
"description": "OK"
1145+
},
1146+
"500": {
1147+
"$ref": "#/components/responses/ServerError"
1148+
}
1149+
},
1150+
"summary": "download backup"
1151+
}
1152+
},
1153+
"/v1/projects/{projectId}/instances/{instanceId}/backups/{backupId}/restore": {
1154+
"post": {
1155+
"operationId": "TriggerRestore",
1156+
"parameters": [
1157+
{
1158+
"$ref": "#/components/parameters/instanceId"
1159+
},
1160+
{
1161+
"$ref": "#/components/parameters/projectId"
1162+
},
1163+
{
1164+
"$ref": "#/components/parameters/backupId"
1165+
}
1166+
],
1167+
"responses": {
1168+
"200": {
1169+
"content": {
1170+
"application/json": {
1171+
"schema": {
1172+
"$ref": "#/components/schemas/TriggerRestoreResponse"
1173+
}
1174+
}
1175+
},
1176+
"description": "OK"
1177+
},
1178+
"404": {
1179+
"$ref": "#/components/responses/NotFound"
1180+
},
1181+
"500": {
1182+
"$ref": "#/components/responses/ServerError"
1183+
}
1184+
},
1185+
"summary": "trigger a restore"
9391186
}
9401187
},
9411188
"/v1/projects/{projectId}/instances/{instanceId}/credentials": {
@@ -1114,6 +1361,99 @@
11141361
"summary": "get latest metrics for cpu load, memory and disk usage"
11151362
}
11161363
},
1364+
"/v1/projects/{projectId}/instances/{instanceId}/recreate": {
1365+
"patch": {
1366+
"operationId": "TriggerRecreate",
1367+
"parameters": [
1368+
{
1369+
"$ref": "#/components/parameters/instanceId"
1370+
},
1371+
{
1372+
"$ref": "#/components/parameters/projectId"
1373+
}
1374+
],
1375+
"responses": {
1376+
"202": {
1377+
"content": {
1378+
"application/json": {
1379+
"schema": {
1380+
"$ref": "#/components/schemas/CreateInstanceResponse"
1381+
}
1382+
}
1383+
},
1384+
"description": "Accepted"
1385+
},
1386+
"404": {
1387+
"$ref": "#/components/responses/NotFound"
1388+
},
1389+
"500": {
1390+
"$ref": "#/components/responses/ServerError"
1391+
}
1392+
},
1393+
"summary": "trigger a recreate"
1394+
}
1395+
},
1396+
"/v1/projects/{projectId}/instances/{instanceId}/restart": {
1397+
"patch": {
1398+
"operationId": "TriggerRestart",
1399+
"parameters": [
1400+
{
1401+
"$ref": "#/components/parameters/instanceId"
1402+
},
1403+
{
1404+
"$ref": "#/components/parameters/projectId"
1405+
}
1406+
],
1407+
"responses": {
1408+
"202": {
1409+
"content": {
1410+
"application/json": {
1411+
"schema": {
1412+
"$ref": "#/components/schemas/CreateInstanceResponse"
1413+
}
1414+
}
1415+
},
1416+
"description": "Accepted"
1417+
},
1418+
"404": {
1419+
"$ref": "#/components/responses/NotFound"
1420+
},
1421+
"500": {
1422+
"$ref": "#/components/responses/ServerError"
1423+
}
1424+
},
1425+
"summary": "trigger a restart"
1426+
}
1427+
},
1428+
"/v1/projects/{projectId}/instances/{instanceId}/restores": {
1429+
"get": {
1430+
"operationId": "ListRestores",
1431+
"parameters": [
1432+
{
1433+
"$ref": "#/components/parameters/instanceId"
1434+
},
1435+
{
1436+
"$ref": "#/components/parameters/projectId"
1437+
}
1438+
],
1439+
"responses": {
1440+
"200": {
1441+
"content": {
1442+
"application/json": {
1443+
"schema": {
1444+
"$ref": "#/components/schemas/ListRestoresResponse"
1445+
}
1446+
}
1447+
},
1448+
"description": "OK"
1449+
},
1450+
"404": {
1451+
"$ref": "#/components/responses/NotFound"
1452+
}
1453+
},
1454+
"summary": "get latest restore information for provided instanceId"
1455+
}
1456+
},
11171457
"/v1/projects/{projectId}/offerings": {
11181458
"get": {
11191459
"description": "Get the service offerings that the service broker offers.",

0 commit comments

Comments
 (0)