Skip to content

Commit b106698

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 73a0cb7 commit b106698

File tree

2 files changed

+223
-83
lines changed

2 files changed

+223
-83
lines changed

‎services/iaas/v1alpha1/iaas.json‎

Lines changed: 78 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,16 @@
6565
"type": "string"
6666
}
6767
},
68+
"v1ListAllImages": {
69+
"description": "List all Images.",
70+
"in": "query",
71+
"name": "all",
72+
"schema": {
73+
"default": false,
74+
"example": true,
75+
"type": "boolean"
76+
}
77+
},
6878
"v1LogLength": {
6979
"description": "Request the server log. By default the length is limited to 2000 lines. Set to 0 to retrieve the complete log.",
7080
"in": "query",
@@ -537,8 +547,8 @@
537547
"type": "object"
538548
},
539549
"AffinityGroupPolicy": {
540-
"description": "The affinity group policy.",
541-
"example": "anti-affinity",
550+
"description": "The affinity group policy.\n`hard-affinity`: All servers in this group will be hosted on the same compute node.\n`soft-affinity`: All servers in this group will be hosted on as few compute nodes as possible.\n`hard-anti-affinity`: All servers in this group will be hosted on different compute nodes.\n`soft-anti-affinity`: All servers in this group will be hosted on as many compute nodes as possible.\nPossible values: `hard-anti-affinity`, `hard-affinity`, `soft-anti-affinity`, `soft-affinity`.",
551+
"example": "hard-anti-affinity",
542552
"type": "string"
543553
},
544554
"AllowedAddresses": {
@@ -797,11 +807,11 @@
797807
"type": "object"
798808
},
799809
"BackupSourceTypes": {
800-
"description": "The source types of a backup.",
810+
"description": "The source types of a backup.\nPossible values: `volume`, `snapshot`.",
801811
"type": "string"
802812
},
803813
"BackupStatus": {
804-
"description": "The status of a backup object.",
814+
"description": "The status of a backup object.\nPossible values: `AVAILABLE`, `CREATING`, `DELETED`, `DELETING`, `ERROR`, `RESTORING`.",
805815
"example": "AVAILABLE",
806816
"type": "string"
807817
},
@@ -930,7 +940,7 @@
930940
"type": "object"
931941
},
932942
"BootVolumeSourceTypes": {
933-
"description": "The source types of a boot volume.",
943+
"description": "The source types of a boot volume.\nPossible values: `image`, `volume`.",
934944
"type": "string"
935945
},
936946
"CIDR": {
@@ -1084,6 +1094,14 @@
10841094
],
10851095
"readOnly": true
10861096
},
1097+
"size": {
1098+
"allOf": [
1099+
{
1100+
"$ref": "#/components/schemas/SizeInBytes"
1101+
}
1102+
],
1103+
"readOnly": true
1104+
},
10871105
"status": {
10881106
"allOf": [
10891107
{
@@ -1538,7 +1556,7 @@
15381556
"keypairName": {
15391557
"allOf": [
15401558
{
1541-
"$ref": "#/components/schemas/GenericName"
1559+
"$ref": "#/components/schemas/KeyPairName"
15421560
}
15431561
],
15441562
"description": "The SSH keypair used during the server creation."
@@ -1850,7 +1868,6 @@
18501868
"type": "string"
18511869
},
18521870
"DeleteOnTermination": {
1853-
"default": false,
18541871
"description": "Delete the volume during the termination of the server. Defaults to false.",
18551872
"type": "boolean"
18561873
},
@@ -1861,7 +1878,7 @@
18611878
"type": "string"
18621879
},
18631880
"DiskFormat": {
1864-
"description": "Object that represents a disk format.",
1881+
"description": "Object that represents a disk format.\nPossible values: `raw`, `qcow2`, `iso`.",
18651882
"type": "string"
18661883
},
18671884
"Error": {
@@ -2013,6 +2030,14 @@
20132030
],
20142031
"readOnly": true
20152032
},
2033+
"size": {
2034+
"allOf": [
2035+
{
2036+
"$ref": "#/components/schemas/SizeInBytes"
2037+
}
2038+
],
2039+
"readOnly": true
2040+
},
20162041
"status": {
20172042
"allOf": [
20182043
{
@@ -2068,9 +2093,16 @@
20682093
"ImageConfig": {
20692094
"description": "Properties to set hardware and scheduling settings for an Image.",
20702095
"properties": {
2096+
"architecture": {
2097+
"description": "Represents CPU architecture. The default for new images is x86.",
2098+
"type": "string",
2099+
"x-extensible-enum": [
2100+
"arm64",
2101+
"x86"
2102+
]
2103+
},
20712104
"bootMenu": {
2072-
"default": false,
2073-
"description": "Enables the BIOS bootmenu.",
2105+
"description": "Enables the BIOS bootmenu. The default for new images is disabled.",
20742106
"type": "boolean"
20752107
},
20762108
"cdromBus": {
@@ -2148,13 +2180,11 @@
21482180
]
21492181
},
21502182
"secureBoot": {
2151-
"default": false,
2152-
"description": "Enables Secure Boot.",
2183+
"description": "Enables Secure Boot. The default for new images is disabled.",
21532184
"type": "boolean"
21542185
},
21552186
"uefi": {
2156-
"default": false,
2157-
"description": "Enables UEFI boot.",
2187+
"description": "Configure UEFI boot. The default for new images is enabled.",
21582188
"type": "boolean"
21592189
},
21602190
"videoModel": {
@@ -2171,8 +2201,7 @@
21712201
]
21722202
},
21732203
"virtioScsi": {
2174-
"default": false,
2175-
"description": "Enables the use of VirtIO SCSI to provide block device access. By default instances use VirtIO Block.",
2204+
"description": "Enables the use of VirtIO SCSI to provide block device access. By default servers use VirtIO Block.",
21762205
"type": "boolean"
21772206
}
21782207
},
@@ -2215,7 +2244,7 @@
22152244
"type": "object"
22162245
},
22172246
"ImageScope": {
2218-
"description": "Scope of an Image.",
2247+
"description": "Scope of an Image.\nPossible values: `public`, `local`, `projects`, `organization`.",
22192248
"example": "local",
22202249
"type": "string"
22212250
},
@@ -2273,7 +2302,7 @@
22732302
}
22742303
},
22752304
"ImageStatus": {
2276-
"description": "The status of an image object.",
2305+
"description": "The status of an image object.\nPossible values: `AVAILABLE`, `CREATING`, `DEACTIVATED`, `DELETED`, `DELETING`, `ERROR`.",
22772306
"example": "AVAILABLE",
22782307
"type": "string"
22792308
},
@@ -2354,9 +2383,9 @@
23542383
"type": "object"
23552384
},
23562385
"Labels": {
2357-
"description": "Object that represents the labels of an object.",
2386+
"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}$`.",
23582387
"example": {
2359-
"foo": "Foo Value"
2388+
"key": "value"
23602389
},
23612390
"format": "json",
23622391
"type": "object"
@@ -2376,7 +2405,7 @@
23762405
"MachineType": {
23772406
"description": "Machine Type.",
23782407
"example": {
2379-
"description": "small, specific instances with cpu-overcommit. Runs on various Intel CPUs.",
2408+
"description": "small, specific servers with cpu-overcommit. Runs on various Intel CPUs.",
23802409
"disk": 1,
23812410
"extraSpecs": {
23822411
"cpu": "intel-ivybridge-generic",
@@ -2946,7 +2975,7 @@
29462975
"type": "object"
29472976
},
29482977
"ProtocolName": {
2949-
"description": "The protocol name which the rule should match.",
2978+
"description": "The protocol name which the rule should match.\nPossible values: `ah`, `dccp`, `egp`, `esp`, `gre`, `icmp`, `igmp`, `ipip`, `ipv6-encap`, `ipv6-frag`, `ipv6-icmp`, `ipv6-nonxt`, `ipv6-opts`, `ipv6-route`, `ospf`, `pgm`, `rsvp`, `sctp`, `tcp`, `udp`, `udplite`, `vrrp`.",
29502979
"type": "string"
29512980
},
29522981
"ProtocolNumber": {
@@ -3355,17 +3384,17 @@
33553384
"type": "object"
33563385
},
33573386
"Resource": {
3358-
"description": "Object that represents a resource type.",
3387+
"description": "Object that represents a resource type.\nPossible values: `BACKUP`, `IMAGE`, `NETWORK`, `NETWORKAREA`, `NIC`, `PROJECT`, `ROUTE`, `SERVER`, `SERVICEACCOUNT`, `SNAPSHOT`, `VIRTUALIP`, `VOLUME`.",
33593388
"example": "SERVER",
33603389
"type": "string"
33613390
},
33623391
"ResourceAction": {
3363-
"description": "Object that represents a resource action.",
3392+
"description": "Object that represents a resource action.\nPossible values: `CREATE`, `DELETE`, `UPDATE`.",
33643393
"example": "CREATE",
33653394
"type": "string"
33663395
},
33673396
"ResourceState": {
3368-
"description": "The state of a resource object.",
3397+
"description": "The state of a resource object.\nPossible values: `CREATING`, `CREATED`, `DELETING`, `DELETED`, `FAILED`, `UPDATED`, `UPDATING`.",
33693398
"example": "CREATING",
33703399
"type": "string"
33713400
},
@@ -3439,7 +3468,7 @@
34393468
"SSHPublicKey": {
34403469
"description": "Object that represents a public SSH key.",
34413470
"example": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIDsPd27M449akqCtdFg2+AmRVJz6eWio0oMP9dVg7Xe",
3442-
"pattern": "^(ssh-rsa|ssh-ed25519)\\s+[A-Za-z0-9+/]+[=]{0,3}(\\s+.+)?\\s*$",
3471+
"pattern": "^(ssh-rsa|ssh-ed25519|ecdsa-sha2-nistp(256|384|521))\\s+[A-Za-z0-9+/]+[=]{0,3}(\\s+.+)?\\s*$",
34433472
"type": "string"
34443473
},
34453474
"SecurityGroup": {
@@ -3613,7 +3642,7 @@
36133642
"keypairName": {
36143643
"allOf": [
36153644
{
3616-
"$ref": "#/components/schemas/GenericName"
3645+
"$ref": "#/components/schemas/KeyPairName"
36173646
}
36183647
],
36193648
"description": "The SSH keypair used during the server creation."
@@ -3850,7 +3879,6 @@
38503879
"$ref": "#/components/schemas/UUID"
38513880
},
38523881
"nicSecurity": {
3853-
"default": true,
38543882
"description": "If this is set to false, then no security groups will apply to this server network interface.",
38553883
"type": "boolean"
38563884
},
@@ -3871,12 +3899,12 @@
38713899
"type": "object"
38723900
},
38733901
"ServerPowerStatus": {
3874-
"description": "The power status of a server.",
3902+
"description": "The power status of a server.\nPossible values: `CRASHED`, `ERROR`, `RUNNING`, `STOPPED`.",
38753903
"example": "RUNNING",
38763904
"type": "string"
38773905
},
38783906
"ServerStatus": {
3879-
"description": "The status of a server object.",
3907+
"description": "The status of a server object.\nPossible values: `ACTIVE`, `BACKING-UP`, `CREATING`, `DEALLOCATED`, `DEALLOCATING`, `DELETED`, `DELETING`, `ERROR`, `INACTIVE`, `MIGRATING`, `REBOOT`, `REBOOTING`, `REBUILD`, `REBUILDING`, `RESCUE`, `RESCUING`, `RESIZING`, `RESTORING`, `SNAPSHOTTING`, `STARTING`, `STOPPING`, `UNRESCUING`, `UPDATING`.",
38803908
"example": "ACTIVE",
38813909
"type": "string"
38823910
},
@@ -3930,6 +3958,12 @@
39303958
}
39313959
}
39323960
},
3961+
"SizeInBytes": {
3962+
"description": "Size in bytes.",
3963+
"example": 1401946112,
3964+
"format": "int64",
3965+
"type": "integer"
3966+
},
39333967
"SizeInGB": {
39343968
"description": "Size in Gigabyte.",
39353969
"example": 1337,
@@ -4020,7 +4054,7 @@
40204054
"type": "object"
40214055
},
40224056
"SnapshotStatus": {
4023-
"description": "The status of a snapshot object.",
4057+
"description": "The status of a snapshot object.\nPossible values: `AVAILABLE`, `BACKING-UP`, `CREATING`, `DELETED`, `DELETING`, `ERROR`, `RESTORING`, `UNMANAGING`, `UPDATING`.",
40244058
"example": "AVAILABLE",
40254059
"type": "string"
40264060
},
@@ -4360,7 +4394,7 @@
43604394
"$ref": "#/components/schemas/Labels"
43614395
},
43624396
"name": {
4363-
"$ref": "#/components/schemas/GenericName"
4397+
"$ref": "#/components/schemas/ServerName"
43644398
}
43654399
},
43664400
"type": "object"
@@ -4622,7 +4656,6 @@
46224656
"type": "object"
46234657
},
46244658
"VolumeBootable": {
4625-
"default": false,
46264659
"description": "Indicates if a volume is bootable.",
46274660
"example": true,
46284661
"type": "boolean"
@@ -4715,11 +4748,11 @@
47154748
"type": "object"
47164749
},
47174750
"VolumeSourceTypes": {
4718-
"description": "The source types of a volume.",
4751+
"description": "The source types of a volume.\nPossible values: `image`, `volume`, `snapshot`, `backup`.",
47194752
"type": "string"
47204753
},
47214754
"VolumeStatus": {
4722-
"description": "The status of a volume object.",
4755+
"description": "The status of a volume object.\nPossible values: `ATTACHED`, `ATTACHING`, `AVAILABLE`, `AWAITING-TRANSFER`, `BACKING-UP`, `CREATING`, `DELETED`, `DELETING`, `DETACHING`, `DOWNLOADING`, `ERROR`, `ERROR_BACKING-UP`, `ERROR_DELETING`, `ERROR_RESIZING`, `ERROR_RESTORING-BACKUP`, `MAINTENANCE`, `RESERVED`, `RESIZING`, `RESTORING-BACKUP`, `RETYPING`, `UPLOADING`.",
47234756
"example": "ATTACHED",
47244757
"type": "string"
47254758
},
@@ -4999,7 +5032,7 @@
49995032
"/v1alpha1/networks/public-ip-ranges": {
50005033
"get": {
50015034
"description": "Get a list of all public IP ranges that STACKIT uses.",
5002-
"operationId": "ListPublicIPRanges",
5035+
"operationId": "ListPublicIpRanges",
50035036
"responses": {
50045037
"200": {
50055038
"content": {
@@ -6430,6 +6463,9 @@
64306463
"description": "Get a list of all images inside a project.",
64316464
"operationId": "ListImages",
64326465
"parameters": [
6466+
{
6467+
"$ref": "#/components/parameters/v1ListAllImages"
6468+
},
64336469
{
64346470
"$ref": "#/components/parameters/v1LabelSelector"
64356471
}
@@ -6488,7 +6524,7 @@
64886524
"active": true,
64896525
"diskFormat": "qcow2",
64906526
"labels": {
6491-
"foo": "Foo Value"
6527+
"key": "value"
64926528
},
64936529
"minDiskSize": 10,
64946530
"minRam": 1,
@@ -9048,15 +9084,15 @@
90489084
},
90499085
"machineType": "t1.1",
90509086
"name": "bootFromExistingVolume",
9051-
"network": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
9087+
"networking": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
90529088
}
90539089
},
90549090
"BootFromImage": {
90559091
"value": {
90569092
"image": "e24b1440-8d9c-431b-8da4-02916720fab5",
90579093
"machineType": "t1.1",
90589094
"name": "bootFromImage",
9059-
"network": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
9095+
"networking": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
90609096
}
90619097
},
90629098
"BootImageFromVolume": {
@@ -9070,7 +9106,7 @@
90709106
},
90719107
"machineType": "t1.1",
90729108
"name": "bootImageFromVolume",
9073-
"network": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
9109+
"networking": "ef018b02-74e9-4f70-87bb-ce1a9742afb9"
90749110
}
90759111
},
90769112
"FullExample": {
@@ -9088,11 +9124,11 @@
90889124
},
90899125
"keypair": "keypair-517e9448-1cf1-4b36-9f29-6e66d669a6d2",
90909126
"labels": {
9091-
"foo": "Foo Value"
9127+
"key": "value"
90929128
},
90939129
"machineType": "t1.1",
90949130
"name": "server1",
9095-
"network": "ef018b02-74e9-4f70-87bb-ce1a9742afb9",
9131+
"networking": "ef018b02-74e9-4f70-87bb-ce1a9742afb9",
90969132
"securityGroups": [
90979133
"188de165-5767-4fc2-8710-a4d2017249e7"
90989134
],

0 commit comments

Comments
 (0)