Skip to content

Commit 252a4fe

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent c77572d commit 252a4fe

File tree

3 files changed

+171
-66
lines changed

3 files changed

+171
-66
lines changed

‎services/iaas/v1/iaas.json

Lines changed: 57 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,10 @@
428428
"TooManyRequests": {
429429
"content": {
430430
"application/json": {
431+
"example": {
432+
"code": 429,
433+
"msg": "Too Many Requests"
434+
},
431435
"schema": {
432436
"$ref": "#/components/schemas/Error"
433437
}
@@ -798,7 +802,7 @@
798802
"$ref": "#/components/schemas/Description"
799803
},
800804
"direction": {
801-
"description": "The direction of the traffic which the rule should match.",
805+
"description": "The direction of the traffic which the rule should match.\nPossible values: `ingress`, `egress`.",
802806
"type": "string",
803807
"x-extensible-enum": [
804808
"ingress",
@@ -807,7 +811,7 @@
807811
},
808812
"ethertype": {
809813
"default": "IPv4",
810-
"description": "The ethertype which the rule should match.",
814+
"description": "The ethertype which the rule should match.\nPossible values: `IPv4`, `IPv6`.",
811815
"type": "string",
812816
"x-extensible-enum": [
813817
"IPv4",
@@ -1008,6 +1012,9 @@
10081012
"CreateImagePayload": {
10091013
"description": "Object that represents an Image and its parameters. Used for Creating and returning (get/list).",
10101014
"properties": {
1015+
"agent": {
1016+
"$ref": "#/components/schemas/ImageAgent"
1017+
},
10111018
"checksum": {
10121019
"allOf": [
10131020
{
@@ -1059,8 +1066,7 @@
10591066
"readOnly": true
10601067
},
10611068
"protected": {
1062-
"example": false,
1063-
"type": "boolean"
1069+
"$ref": "#/components/schemas/ImageProtected"
10641070
},
10651071
"scope": {
10661072
"allOf": [
@@ -1323,6 +1329,7 @@
13231329
"$ref": "#/components/schemas/UUIDList"
13241330
},
13251331
"status": {
1332+
"description": "Possible values: `ACTIVE`, `DOWN`.",
13261333
"readOnly": true,
13271334
"type": "string",
13281335
"x-extensible-enum": [
@@ -1331,6 +1338,7 @@
13311338
]
13321339
},
13331340
"type": {
1341+
"description": "Possible values: `server`, `metadata`, `gateway`, `none`.",
13341342
"readOnly": true,
13351343
"type": "string",
13361344
"x-extensible-enum": [
@@ -1723,7 +1731,7 @@
17231731
"type": "object"
17241732
},
17251733
"CreateVolumePayload": {
1726-
"description": "Object that represents a volume and its parameters. Used for Creating and returning (get/list).",
1734+
"description": "Object that represents a volume and its parameters. Volumes sized up to 16000GB are supported.",
17271735
"properties": {
17281736
"availabilityZone": {
17291737
"$ref": "#/components/schemas/AvailabilityZone"
@@ -1919,6 +1927,9 @@
19191927
"Image": {
19201928
"description": "Object that represents an Image and its parameters. Used for Creating and returning (get/list).",
19211929
"properties": {
1930+
"agent": {
1931+
"$ref": "#/components/schemas/ImageAgent"
1932+
},
19221933
"checksum": {
19231934
"allOf": [
19241935
{
@@ -1970,8 +1981,7 @@
19701981
"readOnly": true
19711982
},
19721983
"protected": {
1973-
"example": false,
1974-
"type": "boolean"
1984+
"$ref": "#/components/schemas/ImageProtected"
19751985
},
19761986
"scope": {
19771987
"allOf": [
@@ -2012,6 +2022,20 @@
20122022
],
20132023
"type": "object"
20142024
},
2025+
"ImageAgent": {
2026+
"description": "Support status and default provioning setting for the STACKIT server agent.",
2027+
"properties": {
2028+
"provisionByDefault": {
2029+
"description": "Default provioning of the STACKIT server agent for new servers. The default for new images is false. Can only be enabled when supported is also true.",
2030+
"type": "boolean"
2031+
},
2032+
"supported": {
2033+
"description": "Indicates the STACKIT server agent for the image. The default for new images is false.",
2034+
"type": "boolean"
2035+
}
2036+
},
2037+
"type": "object"
2038+
},
20152039
"ImageChecksum": {
20162040
"description": "Representation of an image checksum.",
20172041
"example": {
@@ -2020,7 +2044,7 @@
20202044
},
20212045
"properties": {
20222046
"algorithm": {
2023-
"description": "Algorithm for the checksum of the image data.",
2047+
"description": "Algorithm for the checksum of the image data.\nPossible values: `md5`, `sha512`.",
20242048
"example": "sha512",
20252049
"type": "string",
20262050
"x-extensible-enum": [
@@ -2045,7 +2069,7 @@
20452069
"description": "Properties to set hardware and scheduling settings for an Image.",
20462070
"properties": {
20472071
"architecture": {
2048-
"description": "Represents CPU architecture. The default for new images is x86.",
2072+
"description": "Represents CPU architecture. The default for new images is x86.\nPossible values: `arm64`, `x86`.",
20492073
"type": "string",
20502074
"x-extensible-enum": [
20512075
"arm64",
@@ -2057,7 +2081,7 @@
20572081
"type": "boolean"
20582082
},
20592083
"cdromBus": {
2060-
"description": "Sets CDROM bus controller type.",
2084+
"description": "Sets CDROM bus controller type.\nPossible values: `scsi`, `virtio`, `ide`, `usb`.",
20612085
"nullable": true,
20622086
"type": "string",
20632087
"x-extensible-enum": [
@@ -2068,7 +2092,7 @@
20682092
]
20692093
},
20702094
"diskBus": {
2071-
"description": "Sets Disk bus controller type.",
2095+
"description": "Sets Disk bus controller type.\nPossible values: `scsi`, `virtio`, `ide`, `usb`.",
20722096
"nullable": true,
20732097
"type": "string",
20742098
"x-extensible-enum": [
@@ -2079,7 +2103,7 @@
20792103
]
20802104
},
20812105
"nicModel": {
2082-
"description": "Sets virtual nic model.",
2106+
"description": "Sets virtual nic model.\nPossible values: `e1000`, `e1000e`, `ne2k_pci`, `pcnet`, `rtl8139`, `virtio`, `vmxnet3`.",
20832107
"nullable": true,
20842108
"type": "string",
20852109
"x-extensible-enum": [
@@ -2093,7 +2117,7 @@
20932117
]
20942118
},
20952119
"operatingSystem": {
2096-
"description": "Enables OS specific optimizations.",
2120+
"description": "Enables OS specific optimizations.\nPossible values: `windows`, `linux`.",
20972121
"type": "string",
20982122
"x-extensible-enum": [
20992123
"windows",
@@ -2111,7 +2135,7 @@
21112135
"type": "string"
21122136
},
21132137
"rescueBus": {
2114-
"description": "Sets the device bus when the image is used as a rescue image.",
2138+
"description": "Sets the device bus when the image is used as a rescue image.\nPossible values: `sata`, `scsi`, `virtio`, `usb`.",
21152139
"nullable": true,
21162140
"type": "string",
21172141
"x-extensible-enum": [
@@ -2122,7 +2146,7 @@
21222146
]
21232147
},
21242148
"rescueDevice": {
2125-
"description": "Sets the device when the image is used as a rescue image.",
2149+
"description": "Sets the device when the image is used as a rescue image.\nPossible values: `cdrom`, `disk`.",
21262150
"nullable": true,
21272151
"type": "string",
21282152
"x-extensible-enum": [
@@ -2139,7 +2163,7 @@
21392163
"type": "boolean"
21402164
},
21412165
"videoModel": {
2142-
"description": "Sets Graphic device model.",
2166+
"description": "Sets Graphic device model.\nPossible values: `vga`, `cirrus`, `vmvga`, `qxl`, `virtio`, `none`.",
21432167
"nullable": true,
21442168
"type": "string",
21452169
"x-extensible-enum": [
@@ -2194,6 +2218,11 @@
21942218
],
21952219
"type": "object"
21962220
},
2221+
"ImageProtected": {
2222+
"description": "When true the image is prevented from being deleted.",
2223+
"example": true,
2224+
"type": "boolean"
2225+
},
21972226
"ImageScope": {
21982227
"description": "Scope of an Image.\nPossible values: `public`, `local`, `projects`, `organization`.",
21992228
"example": "local",
@@ -2334,7 +2363,7 @@
23342363
"type": "object"
23352364
},
23362365
"Labels": {
2337-
"description": "Object that represents the labels of an object. Regex for keys: `^[a-z]((-|_|[a-z0-9])){0,62}$`. Regex for values: `^(-|_|[a-z0-9]){0,63}$`.",
2366+
"description": "Object that represents the labels of an object. Regex for keys: `^[a-z]((-|_|[a-z0-9])){0,62}$`. Regex for values: `^(-|_|[a-z0-9]){0,63}$`. Providing a `null` value for a key will remove that key.",
23382367
"example": {
23392368
"key": "value"
23402369
},
@@ -2449,7 +2478,7 @@
24492478
"type": "object"
24502479
},
24512480
"Metadata": {
2452-
"description": "Object that represents the metadata of an object. Regex for keys: `^[a-zA-Z0-9-_:. ]{1,255}$`. Regex for values: `^.{0,255}$`.",
2481+
"description": "Object that represents the metadata of an object. Regex for keys: `^[a-zA-Z0-9-_:. ]{1,255}$`. Regex for values: `^.{0,255}$`. Providing a `null` value for a key will remove that key.",
24532482
"example": {
24542483
"key": "value"
24552484
},
@@ -2518,6 +2547,7 @@
25182547
"$ref": "#/components/schemas/UUIDList"
25192548
},
25202549
"status": {
2550+
"description": "Possible values: `ACTIVE`, `DOWN`.",
25212551
"readOnly": true,
25222552
"type": "string",
25232553
"x-extensible-enum": [
@@ -2526,6 +2556,7 @@
25262556
]
25272557
},
25282558
"type": {
2559+
"description": "Possible values: `server`, `metadata`, `gateway`, `none`.",
25292560
"readOnly": true,
25302561
"type": "string",
25312562
"x-extensible-enum": [
@@ -3758,6 +3789,7 @@
37583789
"type": "string"
37593790
},
37603791
"status": {
3792+
"description": "Possible values: `PLANNED`, `ONGOING`.",
37613793
"type": "string",
37623794
"x-extensible-enum": [
37633795
"PLANNED",
@@ -4162,6 +4194,9 @@
41624194
"UpdateImagePayload": {
41634195
"description": "Object that represents an update request body of an Image.",
41644196
"properties": {
4197+
"agent": {
4198+
"$ref": "#/components/schemas/ImageAgent"
4199+
},
41654200
"config": {
41664201
"$ref": "#/components/schemas/ImageConfig"
41674202
},
@@ -4181,8 +4216,7 @@
41814216
"$ref": "#/components/schemas/GenericName"
41824217
},
41834218
"protected": {
4184-
"example": false,
4185-
"type": "boolean"
4219+
"$ref": "#/components/schemas/ImageProtected"
41864220
}
41874221
},
41884222
"type": "object"
@@ -4356,7 +4390,7 @@
43564390
"type": "object"
43574391
},
43584392
"UpdateVolumePayload": {
4359-
"description": "Object that represents an update request body of a volume.",
4393+
"description": "Object that represents an update request body of a volume.",
43604394
"properties": {
43614395
"bootable": {
43624396
"$ref": "#/components/schemas/VolumeBootable"
@@ -4390,7 +4424,7 @@
43904424
"type": "integer"
43914425
},
43924426
"Volume": {
4393-
"description": "Object that represents a volume and its parameters. Used for Creating and returning (get/list).",
4427+
"description": "Object that represents a volume and its parameters. Volumes sized up to 16000GB are supported.",
43944428
"properties": {
43954429
"availabilityZone": {
43964430
"$ref": "#/components/schemas/AvailabilityZone"
@@ -9269,6 +9303,7 @@
92699303
"name": "action",
92709304
"schema": {
92719305
"default": "soft",
9306+
"description": "Possible values: `soft`, `hard`.",
92729307
"type": "string",
92739308
"x-extensible-enum": [
92749309
"soft",

0 commit comments

Comments
 (0)