Skip to content

Commit 97f7af7

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 01aae86 commit 97f7af7

File tree

1 file changed

+217
-3
lines changed

1 file changed

+217
-3
lines changed

‎services/kms/v1beta/kms.json

Lines changed: 217 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,11 @@
347347
"format": "date-time",
348348
"type": "string"
349349
},
350+
"deletionDate": {
351+
"description": "This date is set when a key is pending deletion and refers to the scheduled date of deletion",
352+
"format": "date-time",
353+
"type": "string"
354+
},
350355
"description": {
351356
"description": "A user chosen description to distinguish multiple keys.",
352357
"maxLength": 256,
@@ -380,7 +385,7 @@
380385
"enum": [
381386
"active",
382387
"version_not_ready",
383-
"deleting"
388+
"deleted"
384389
],
385390
"type": "string"
386391
}
@@ -435,7 +440,7 @@
435440
"description": "The current state of the key ring.",
436441
"enum": [
437442
"active",
438-
"deleting"
443+
"deleted"
439444
],
440445
"type": "string"
441446
}
@@ -506,6 +511,11 @@
506511
"format": "date-time",
507512
"type": "string"
508513
},
514+
"destroyDate": {
515+
"description": "The scheduled date when a version's key material will be erased completely from the backend",
516+
"format": "date-time",
517+
"type": "string"
518+
},
509519
"disabled": {
510520
"default": false,
511521
"description": "States whether versions is enabled or disabled.",
@@ -537,7 +547,7 @@
537547
"key_material_not_ready",
538548
"key_material_invalid",
539549
"disabled",
540-
"deleting"
550+
"destroyed"
541551
],
542552
"type": "string"
543553
}
@@ -764,6 +774,36 @@
764774
}
765775
},
766776
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}": {
777+
"delete": {
778+
"description": "Deletes the given key ring if it is empty",
779+
"operationId": "DeleteKeyRing",
780+
"responses": {
781+
"204": {
782+
"description": "Key ring was deleted successfully."
783+
},
784+
"400": {
785+
"$ref": "#/components/responses/badRequest"
786+
},
787+
"401": {
788+
"$ref": "#/components/responses/unauthorized"
789+
},
790+
"404": {
791+
"$ref": "#/components/responses/notFound"
792+
},
793+
"500": {
794+
"$ref": "#/components/responses/internalServerError"
795+
}
796+
},
797+
"summary": "Delete keyring",
798+
"x-stackit-authorization": {
799+
"actions": [
800+
"kms.keyring.delete"
801+
],
802+
"resource-id": "projectId",
803+
"resource-id-type": "dynamic",
804+
"resource-type": "project"
805+
}
806+
},
767807
"get": {
768808
"description": "Returns the details for the given key ring.",
769809
"operationId": "GetKeyRing",
@@ -911,6 +951,36 @@
911951
}
912952
},
913953
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}": {
954+
"delete": {
955+
"description": "Schedules the deletion of the given key",
956+
"operationId": "DeleteKey",
957+
"responses": {
958+
"202": {
959+
"description": "Deletion was scheduled successfully."
960+
},
961+
"400": {
962+
"$ref": "#/components/responses/badRequest"
963+
},
964+
"401": {
965+
"$ref": "#/components/responses/unauthorized"
966+
},
967+
"404": {
968+
"$ref": "#/components/responses/notFound"
969+
},
970+
"500": {
971+
"$ref": "#/components/responses/internalServerError"
972+
}
973+
},
974+
"summary": "Delete key",
975+
"x-stackit-authorization": {
976+
"actions": [
977+
"kms.keyring.update"
978+
],
979+
"resource-id": "projectId",
980+
"resource-id-type": "dynamic",
981+
"resource-type": "project"
982+
}
983+
},
914984
"get": {
915985
"description": "Returns the details for the given key.",
916986
"operationId": "GetKey",
@@ -1029,6 +1099,52 @@
10291099
}
10301100
}
10311101
},
1102+
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/restore": {
1103+
"parameters": [
1104+
{
1105+
"$ref": "#/components/parameters/projectId"
1106+
},
1107+
{
1108+
"$ref": "#/components/parameters/regionId"
1109+
},
1110+
{
1111+
"$ref": "#/components/parameters/keyRingId"
1112+
},
1113+
{
1114+
"$ref": "#/components/parameters/keyId"
1115+
}
1116+
],
1117+
"post": {
1118+
"description": "Restores the given key from being deleted.",
1119+
"operationId": "RestoreKey",
1120+
"responses": {
1121+
"200": {
1122+
"description": "The key has been restored."
1123+
},
1124+
"400": {
1125+
"$ref": "#/components/responses/badRequest"
1126+
},
1127+
"401": {
1128+
"$ref": "#/components/responses/unauthorized"
1129+
},
1130+
"404": {
1131+
"$ref": "#/components/responses/notFound"
1132+
},
1133+
"500": {
1134+
"$ref": "#/components/responses/internalServerError"
1135+
}
1136+
},
1137+
"summary": "Restore deleted key",
1138+
"x-stackit-authorization": {
1139+
"actions": [
1140+
"kms.keyring.update"
1141+
],
1142+
"resource-id": "projectId",
1143+
"resource-id-type": "dynamic",
1144+
"resource-type": "project"
1145+
}
1146+
}
1147+
},
10321148
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/rotate": {
10331149
"parameters": [
10341150
{
@@ -1266,6 +1382,55 @@
12661382
}
12671383
}
12681384
},
1385+
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/versions/{versionNumber}/destroy": {
1386+
"parameters": [
1387+
{
1388+
"$ref": "#/components/parameters/projectId"
1389+
},
1390+
{
1391+
"$ref": "#/components/parameters/regionId"
1392+
},
1393+
{
1394+
"$ref": "#/components/parameters/keyRingId"
1395+
},
1396+
{
1397+
"$ref": "#/components/parameters/keyId"
1398+
},
1399+
{
1400+
"$ref": "#/components/parameters/versionNumber"
1401+
}
1402+
],
1403+
"post": {
1404+
"description": "Removes the key material of a version permanently.",
1405+
"operationId": "DestroyVersion",
1406+
"responses": {
1407+
"204": {
1408+
"description": "The version has been successfully destroyed."
1409+
},
1410+
"400": {
1411+
"$ref": "#/components/responses/badRequest"
1412+
},
1413+
"401": {
1414+
"$ref": "#/components/responses/unauthorized"
1415+
},
1416+
"404": {
1417+
"$ref": "#/components/responses/notFound"
1418+
},
1419+
"500": {
1420+
"$ref": "#/components/responses/internalServerError"
1421+
}
1422+
},
1423+
"summary": "Destroy version",
1424+
"x-stackit-authorization": {
1425+
"actions": [
1426+
"kms.keyring.update"
1427+
],
1428+
"resource-id": "projectId",
1429+
"resource-id-type": "dynamic",
1430+
"resource-type": "project"
1431+
}
1432+
}
1433+
},
12691434
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/versions/{versionNumber}/disable": {
12701435
"parameters": [
12711436
{
@@ -1433,6 +1598,55 @@
14331598
}
14341599
}
14351600
},
1601+
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/versions/{versionNumber}/restore": {
1602+
"parameters": [
1603+
{
1604+
"$ref": "#/components/parameters/projectId"
1605+
},
1606+
{
1607+
"$ref": "#/components/parameters/regionId"
1608+
},
1609+
{
1610+
"$ref": "#/components/parameters/keyRingId"
1611+
},
1612+
{
1613+
"$ref": "#/components/parameters/keyId"
1614+
},
1615+
{
1616+
"$ref": "#/components/parameters/versionNumber"
1617+
}
1618+
],
1619+
"post": {
1620+
"description": "Restores the given version from being destroyed",
1621+
"operationId": "RestoreVersion",
1622+
"responses": {
1623+
"204": {
1624+
"description": "The version has been successfully restored."
1625+
},
1626+
"400": {
1627+
"$ref": "#/components/responses/badRequest"
1628+
},
1629+
"401": {
1630+
"$ref": "#/components/responses/unauthorized"
1631+
},
1632+
"404": {
1633+
"$ref": "#/components/responses/notFound"
1634+
},
1635+
"500": {
1636+
"$ref": "#/components/responses/internalServerError"
1637+
}
1638+
},
1639+
"summary": "Restore version",
1640+
"x-stackit-authorization": {
1641+
"actions": [
1642+
"kms.keyring.update"
1643+
],
1644+
"resource-id": "projectId",
1645+
"resource-id-type": "dynamic",
1646+
"resource-type": "project"
1647+
}
1648+
}
1649+
},
14361650
"/v1beta/projects/{projectId}/regions/{regionId}/keyrings/{keyRingId}/keys/{keyId}/versions/{versionNumber}/sign": {
14371651
"parameters": [
14381652
{

0 commit comments

Comments
 (0)