Skip to content

Commit ac79f47

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 5771a5b commit ac79f47

File tree

3 files changed

+297
-0
lines changed

3 files changed

+297
-0
lines changed

‎services/iaas/v1/iaas.json

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1754,6 +1754,17 @@
17541754
"description": {
17551755
"$ref": "#/components/schemas/Description"
17561756
},
1757+
"encrypted": {
1758+
"allOf": [
1759+
{
1760+
"$ref": "#/components/schemas/VolumeEncryption"
1761+
}
1762+
],
1763+
"readOnly": true
1764+
},
1765+
"encryptionParameters": {
1766+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
1767+
},
17571768
"id": {
17581769
"allOf": [
17591770
{
@@ -2320,6 +2331,18 @@
23202331
"pattern": "^[A-Za-z0-9@._-]*$",
23212332
"type": "string"
23222333
},
2334+
"KeyPayload": {
2335+
"description": "base64 encoded secret.",
2336+
"example": "VGhpcy1pcy1hLXNlY3JldCE=",
2337+
"format": "byte",
2338+
"type": "string"
2339+
},
2340+
"KeyVersion": {
2341+
"description": "Version of a key within the STACKIT-KMS.",
2342+
"example": 1,
2343+
"format": "int64",
2344+
"type": "integer"
2345+
},
23232346
"Keypair": {
23242347
"description": "Object that represents the public key of an SSH keypair and its name.",
23252348
"properties": {
@@ -4447,6 +4470,17 @@
44474470
"description": {
44484471
"$ref": "#/components/schemas/Description"
44494472
},
4473+
"encrypted": {
4474+
"allOf": [
4475+
{
4476+
"$ref": "#/components/schemas/VolumeEncryption"
4477+
}
4478+
],
4479+
"readOnly": true
4480+
},
4481+
"encryptionParameters": {
4482+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
4483+
},
44504484
"id": {
44514485
"allOf": [
44524486
{
@@ -4557,6 +4591,71 @@
45574591
"example": true,
45584592
"type": "boolean"
45594593
},
4594+
"VolumeEncryption": {
4595+
"description": "Indicates if a volume is encrypted.",
4596+
"example": false,
4597+
"type": "boolean"
4598+
},
4599+
"VolumeEncryptionParameter": {
4600+
"description": "Parameter to connect to a key-encryption-key within the STACKIT-KMS to create encrypted volumes. If no key_payload is set, a random passphrase is generated, which will be encrypted against the STACKIT-KMS. These parameter never leave the backend again. So these parameters are not in the responses.",
4601+
"properties": {
4602+
"kekKeyId": {
4603+
"allOf": [
4604+
{
4605+
"$ref": "#/components/schemas/UUID"
4606+
}
4607+
],
4608+
"description": "UUID of the Key within the STACKIT-KMS to use for the encryption."
4609+
},
4610+
"kekKeyVersion": {
4611+
"allOf": [
4612+
{
4613+
"$ref": "#/components/schemas/KeyVersion"
4614+
}
4615+
],
4616+
"description": "Version of the key within the STACKIT-KMS to use for the encryption."
4617+
},
4618+
"kekKeyringId": {
4619+
"allOf": [
4620+
{
4621+
"$ref": "#/components/schemas/UUID"
4622+
}
4623+
],
4624+
"description": "UUID of the keyring where the key is located within the STACKTI-KMS."
4625+
},
4626+
"kekProjectId": {
4627+
"allOf": [
4628+
{
4629+
"$ref": "#/components/schemas/UUID"
4630+
}
4631+
],
4632+
"description": "Id of the project, where the key in the STACKIT-KMS belongs to, in case the key is located in a different project. By default the same project ID is used, like for the volume itself. Defining a key in a different project is only allowed for privileged internal projects."
4633+
},
4634+
"keyPayload": {
4635+
"allOf": [
4636+
{
4637+
"$ref": "#/components/schemas/KeyPayload"
4638+
}
4639+
],
4640+
"description": "Optional predefined secret, which will be encrypted against the key-encryption-key within the STACKIT-KMS. If not defined, a random secret will be generated by the API and encrypted against the STACKIT-KMS. If a key-payload is provided here, it must be base64 encoded."
4641+
},
4642+
"serviceAccount": {
4643+
"allOf": [
4644+
{
4645+
"$ref": "#/components/schemas/ServiceAccountMail"
4646+
}
4647+
],
4648+
"description": "Service-Account linked to the Key within the STACKIT-KMS."
4649+
}
4650+
},
4651+
"required": [
4652+
"serviceAccount",
4653+
"kekKeyringId",
4654+
"kekKeyId",
4655+
"kekKeyVersion"
4656+
],
4657+
"type": "object"
4658+
},
45604659
"VolumeList": {
45614660
"description": "A list containing volume objects.",
45624661
"items": {

‎services/iaas/v1alpha1/iaas.json

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1765,6 +1765,17 @@
17651765
"description": {
17661766
"$ref": "#/components/schemas/Description"
17671767
},
1768+
"encrypted": {
1769+
"allOf": [
1770+
{
1771+
"$ref": "#/components/schemas/VolumeEncryption"
1772+
}
1773+
],
1774+
"readOnly": true
1775+
},
1776+
"encryptionParameters": {
1777+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
1778+
},
17681779
"id": {
17691780
"allOf": [
17701781
{
@@ -2331,6 +2342,18 @@
23312342
"pattern": "^[A-Za-z0-9@._-]*$",
23322343
"type": "string"
23332344
},
2345+
"KeyPayload": {
2346+
"description": "base64 encoded secret.",
2347+
"example": "VGhpcy1pcy1hLXNlY3JldCE=",
2348+
"format": "byte",
2349+
"type": "string"
2350+
},
2351+
"KeyVersion": {
2352+
"description": "Version of a key within the STACKIT-KMS.",
2353+
"example": 1,
2354+
"format": "int64",
2355+
"type": "integer"
2356+
},
23342357
"Keypair": {
23352358
"description": "Object that represents the public key of an SSH keypair and its name.",
23362359
"properties": {
@@ -4515,6 +4538,17 @@
45154538
"description": {
45164539
"$ref": "#/components/schemas/Description"
45174540
},
4541+
"encrypted": {
4542+
"allOf": [
4543+
{
4544+
"$ref": "#/components/schemas/VolumeEncryption"
4545+
}
4546+
],
4547+
"readOnly": true
4548+
},
4549+
"encryptionParameters": {
4550+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
4551+
},
45184552
"id": {
45194553
"allOf": [
45204554
{
@@ -4625,6 +4659,71 @@
46254659
"example": true,
46264660
"type": "boolean"
46274661
},
4662+
"VolumeEncryption": {
4663+
"description": "Indicates if a volume is encrypted.",
4664+
"example": false,
4665+
"type": "boolean"
4666+
},
4667+
"VolumeEncryptionParameter": {
4668+
"description": "Parameter to connect to a key-encryption-key within the STACKIT-KMS to create encrypted volumes. If no key_payload is set, a random passphrase is generated, which will be encrypted against the STACKIT-KMS. These parameter never leave the backend again. So these parameters are not in the responses.",
4669+
"properties": {
4670+
"kekKeyId": {
4671+
"allOf": [
4672+
{
4673+
"$ref": "#/components/schemas/UUID"
4674+
}
4675+
],
4676+
"description": "UUID of the Key within the STACKIT-KMS to use for the encryption."
4677+
},
4678+
"kekKeyVersion": {
4679+
"allOf": [
4680+
{
4681+
"$ref": "#/components/schemas/KeyVersion"
4682+
}
4683+
],
4684+
"description": "Version of the key within the STACKIT-KMS to use for the encryption."
4685+
},
4686+
"kekKeyringId": {
4687+
"allOf": [
4688+
{
4689+
"$ref": "#/components/schemas/UUID"
4690+
}
4691+
],
4692+
"description": "UUID of the keyring where the key is located within the STACKTI-KMS."
4693+
},
4694+
"kekProjectId": {
4695+
"allOf": [
4696+
{
4697+
"$ref": "#/components/schemas/UUID"
4698+
}
4699+
],
4700+
"description": "Id of the project, where the key in the STACKIT-KMS belongs to, in case the key is located in a different project. By default the same project ID is used, like for the volume itself. Defining a key in a different project is only allowed for privileged internal projects."
4701+
},
4702+
"keyPayload": {
4703+
"allOf": [
4704+
{
4705+
"$ref": "#/components/schemas/KeyPayload"
4706+
}
4707+
],
4708+
"description": "Optional predefined secret, which will be encrypted against the key-encryption-key within the STACKIT-KMS. If not defined, a random secret will be generated by the API and encrypted against the STACKIT-KMS. If a key-payload is provided here, it must be base64 encoded."
4709+
},
4710+
"serviceAccount": {
4711+
"allOf": [
4712+
{
4713+
"$ref": "#/components/schemas/ServiceAccountMail"
4714+
}
4715+
],
4716+
"description": "Service-Account linked to the Key within the STACKIT-KMS."
4717+
}
4718+
},
4719+
"required": [
4720+
"serviceAccount",
4721+
"kekKeyringId",
4722+
"kekKeyId",
4723+
"kekKeyVersion"
4724+
],
4725+
"type": "object"
4726+
},
46284727
"VolumeList": {
46294728
"description": "A list containing volume objects.",
46304729
"items": {

‎services/iaas/v1beta1/iaas.json

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1754,6 +1754,17 @@
17541754
"description": {
17551755
"$ref": "#/components/schemas/Description"
17561756
},
1757+
"encrypted": {
1758+
"allOf": [
1759+
{
1760+
"$ref": "#/components/schemas/VolumeEncryption"
1761+
}
1762+
],
1763+
"readOnly": true
1764+
},
1765+
"encryptionParameters": {
1766+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
1767+
},
17571768
"id": {
17581769
"allOf": [
17591770
{
@@ -2320,6 +2331,18 @@
23202331
"pattern": "^[A-Za-z0-9@._-]*$",
23212332
"type": "string"
23222333
},
2334+
"KeyPayload": {
2335+
"description": "base64 encoded secret.",
2336+
"example": "VGhpcy1pcy1hLXNlY3JldCE=",
2337+
"format": "byte",
2338+
"type": "string"
2339+
},
2340+
"KeyVersion": {
2341+
"description": "Version of a key within the STACKIT-KMS.",
2342+
"example": 1,
2343+
"format": "int64",
2344+
"type": "integer"
2345+
},
23232346
"Keypair": {
23242347
"description": "Object that represents the public key of an SSH keypair and its name.",
23252348
"properties": {
@@ -4447,6 +4470,17 @@
44474470
"description": {
44484471
"$ref": "#/components/schemas/Description"
44494472
},
4473+
"encrypted": {
4474+
"allOf": [
4475+
{
4476+
"$ref": "#/components/schemas/VolumeEncryption"
4477+
}
4478+
],
4479+
"readOnly": true
4480+
},
4481+
"encryptionParameters": {
4482+
"$ref": "#/components/schemas/VolumeEncryptionParameter"
4483+
},
44504484
"id": {
44514485
"allOf": [
44524486
{
@@ -4557,6 +4591,71 @@
45574591
"example": true,
45584592
"type": "boolean"
45594593
},
4594+
"VolumeEncryption": {
4595+
"description": "Indicates if a volume is encrypted.",
4596+
"example": false,
4597+
"type": "boolean"
4598+
},
4599+
"VolumeEncryptionParameter": {
4600+
"description": "Parameter to connect to a key-encryption-key within the STACKIT-KMS to create encrypted volumes. If no key_payload is set, a random passphrase is generated, which will be encrypted against the STACKIT-KMS. These parameter never leave the backend again. So these parameters are not in the responses.",
4601+
"properties": {
4602+
"kekKeyId": {
4603+
"allOf": [
4604+
{
4605+
"$ref": "#/components/schemas/UUID"
4606+
}
4607+
],
4608+
"description": "UUID of the Key within the STACKIT-KMS to use for the encryption."
4609+
},
4610+
"kekKeyVersion": {
4611+
"allOf": [
4612+
{
4613+
"$ref": "#/components/schemas/KeyVersion"
4614+
}
4615+
],
4616+
"description": "Version of the key within the STACKIT-KMS to use for the encryption."
4617+
},
4618+
"kekKeyringId": {
4619+
"allOf": [
4620+
{
4621+
"$ref": "#/components/schemas/UUID"
4622+
}
4623+
],
4624+
"description": "UUID of the keyring where the key is located within the STACKTI-KMS."
4625+
},
4626+
"kekProjectId": {
4627+
"allOf": [
4628+
{
4629+
"$ref": "#/components/schemas/UUID"
4630+
}
4631+
],
4632+
"description": "Id of the project, where the key in the STACKIT-KMS belongs to, in case the key is located in a different project. By default the same project ID is used, like for the volume itself. Defining a key in a different project is only allowed for privileged internal projects."
4633+
},
4634+
"keyPayload": {
4635+
"allOf": [
4636+
{
4637+
"$ref": "#/components/schemas/KeyPayload"
4638+
}
4639+
],
4640+
"description": "Optional predefined secret, which will be encrypted against the key-encryption-key within the STACKIT-KMS. If not defined, a random secret will be generated by the API and encrypted against the STACKIT-KMS. If a key-payload is provided here, it must be base64 encoded."
4641+
},
4642+
"serviceAccount": {
4643+
"allOf": [
4644+
{
4645+
"$ref": "#/components/schemas/ServiceAccountMail"
4646+
}
4647+
],
4648+
"description": "Service-Account linked to the Key within the STACKIT-KMS."
4649+
}
4650+
},
4651+
"required": [
4652+
"serviceAccount",
4653+
"kekKeyringId",
4654+
"kekKeyId",
4655+
"kekKeyVersion"
4656+
],
4657+
"type": "object"
4658+
},
45604659
"VolumeList": {
45614660
"description": "A list containing volume objects.",
45624661
"items": {

0 commit comments

Comments
 (0)