Skip to content

Commit 38bda06

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 8ccf08f commit 38bda06

1 file changed

Lines changed: 267 additions & 0 deletions

File tree

‎services/ufw/v1beta/ufw.json‎

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@
2929
"type": "string"
3030
}
3131
},
32+
"folderId": {
33+
"description": "The STACKIT portal folder UUID the key ring is part of.",
34+
"in": "path",
35+
"name": "folderId",
36+
"required": true,
37+
"schema": {
38+
"format": "uuid",
39+
"type": "string"
40+
}
41+
},
3242
"instanceIdPath": {
3343
"description": "The ID of the source, similar to a project ID but for the product service instance.",
3444
"in": "path",
@@ -64,6 +74,16 @@
6474
"type": "integer"
6575
}
6676
},
77+
"organizationId": {
78+
"description": "The STACKIT portal organization UUID the key ring is part of.",
79+
"in": "path",
80+
"name": "organizationId",
81+
"required": true,
82+
"schema": {
83+
"format": "uuid",
84+
"type": "string"
85+
}
86+
},
6787
"portRange": {
6888
"description": "The port range for the rule.",
6989
"example": "80-8080",
@@ -242,6 +262,25 @@
242262
}
243263
},
244264
"schemas": {
265+
"ContainerResponse": {
266+
"properties": {
267+
"id": {
268+
"type": "string"
269+
},
270+
"name": {
271+
"type": "string"
272+
},
273+
"type": {
274+
"type": "string"
275+
}
276+
},
277+
"required": [
278+
"id",
279+
"name",
280+
"type"
281+
],
282+
"type": "object"
283+
},
245284
"CreateRulePayload": {
246285
"description": "The request body for creating a new security rule.",
247286
"properties": {
@@ -322,6 +361,28 @@
322361
},
323362
"type": "object"
324363
},
364+
"ListContainersResponse": {
365+
"properties": {
366+
"cursor": {
367+
"type": "string"
368+
},
369+
"items": {
370+
"items": {
371+
"$ref": "#/components/schemas/ContainerResponse"
372+
},
373+
"type": "array"
374+
},
375+
"limit": {
376+
"type": "integer"
377+
}
378+
},
379+
"required": [
380+
"items",
381+
"cursor",
382+
"limit"
383+
],
384+
"type": "object"
385+
},
325386
"ProviderOptionsProductMeta": {
326387
"properties": {
327388
"actions": {
@@ -609,6 +670,212 @@
609670
},
610671
"openapi": "3.0.3",
611672
"paths": {
673+
"/v1beta/folders/{folderId}/children": {
674+
"get": {
675+
"description": "Returns a list of containers for a specific folder",
676+
"operationId": "v1beta-get-folder-resources",
677+
"parameters": [
678+
{
679+
"$ref": "#/components/parameters/folderId"
680+
},
681+
{
682+
"$ref": "#/components/parameters/limit"
683+
},
684+
{
685+
"$ref": "#/components/parameters/cursor"
686+
}
687+
],
688+
"responses": {
689+
"200": {
690+
"content": {
691+
"application/json": {
692+
"schema": {
693+
"$ref": "#/components/schemas/ListContainersResponse"
694+
}
695+
}
696+
},
697+
"description": "Successful response"
698+
},
699+
"400": {
700+
"content": {
701+
"application/json": {
702+
"schema": {
703+
"$ref": "#/components/schemas/ErrorResponse"
704+
}
705+
}
706+
},
707+
"description": "Bad request"
708+
},
709+
"401": {
710+
"content": {
711+
"application/json": {
712+
"schema": {
713+
"$ref": "#/components/schemas/ErrorResponse"
714+
}
715+
}
716+
},
717+
"description": "Unauthorized"
718+
},
719+
"403": {
720+
"content": {
721+
"application/json": {
722+
"schema": {
723+
"$ref": "#/components/schemas/ErrorResponse"
724+
}
725+
}
726+
},
727+
"description": "Forbidden access. You are not allowed to get rules from this project."
728+
},
729+
"404": {
730+
"content": {
731+
"application/json": {
732+
"schema": {
733+
"$ref": "#/components/schemas/ErrorResponse"
734+
}
735+
}
736+
},
737+
"description": "Folder not found."
738+
},
739+
"500": {
740+
"content": {
741+
"application/json": {
742+
"schema": {
743+
"$ref": "#/components/schemas/ErrorResponse"
744+
}
745+
}
746+
},
747+
"description": "Service is not available."
748+
},
749+
"503": {
750+
"content": {
751+
"application/json": {
752+
"schema": {
753+
"$ref": "#/components/schemas/ErrorResponse"
754+
}
755+
}
756+
},
757+
"description": "Service is not available."
758+
}
759+
},
760+
"security": [
761+
{
762+
"BearerAuth": []
763+
}
764+
],
765+
"summary": "Get containers from a folder",
766+
"x-stackit-authorization": {
767+
"actions": [
768+
"ufw.folder.list"
769+
],
770+
"resource-id": "folderId",
771+
"resource-id-type": "dynamic",
772+
"resource-type": "folder"
773+
}
774+
}
775+
},
776+
"/v1beta/organizations/{organizationId}/children": {
777+
"get": {
778+
"description": "Returns a list of containers for a specific organization",
779+
"operationId": "v1beta-get-organization-resources",
780+
"parameters": [
781+
{
782+
"$ref": "#/components/parameters/organizationId"
783+
},
784+
{
785+
"$ref": "#/components/parameters/limit"
786+
},
787+
{
788+
"$ref": "#/components/parameters/cursor"
789+
}
790+
],
791+
"responses": {
792+
"200": {
793+
"content": {
794+
"application/json": {
795+
"schema": {
796+
"$ref": "#/components/schemas/ListContainersResponse"
797+
}
798+
}
799+
},
800+
"description": "Successful response"
801+
},
802+
"400": {
803+
"content": {
804+
"application/json": {
805+
"schema": {
806+
"$ref": "#/components/schemas/ErrorResponse"
807+
}
808+
}
809+
},
810+
"description": "Bad request"
811+
},
812+
"401": {
813+
"content": {
814+
"application/json": {
815+
"schema": {
816+
"$ref": "#/components/schemas/ErrorResponse"
817+
}
818+
}
819+
},
820+
"description": "Unauthorized"
821+
},
822+
"403": {
823+
"content": {
824+
"application/json": {
825+
"schema": {
826+
"$ref": "#/components/schemas/ErrorResponse"
827+
}
828+
}
829+
},
830+
"description": "Forbidden access. You are not allowed to get containers from this folder."
831+
},
832+
"404": {
833+
"content": {
834+
"application/json": {
835+
"schema": {
836+
"$ref": "#/components/schemas/ErrorResponse"
837+
}
838+
}
839+
},
840+
"description": "Folder not found."
841+
},
842+
"500": {
843+
"content": {
844+
"application/json": {
845+
"schema": {
846+
"$ref": "#/components/schemas/ErrorResponse"
847+
}
848+
}
849+
},
850+
"description": "Service is not available."
851+
},
852+
"503": {
853+
"content": {
854+
"application/json": {
855+
"schema": {
856+
"$ref": "#/components/schemas/ErrorResponse"
857+
}
858+
}
859+
},
860+
"description": "Service is not available."
861+
}
862+
},
863+
"security": [
864+
{
865+
"BearerAuth": []
866+
}
867+
],
868+
"summary": "Get containers from an organization",
869+
"x-stackit-authorization": {
870+
"actions": [
871+
"ufw.organization.list"
872+
],
873+
"resource-id": "organizationId",
874+
"resource-id-type": "dynamic",
875+
"resource-type": "organization"
876+
}
877+
}
878+
},
612879
"/v1beta/projects/{projectId}/regions/{regionId}/rules": {
613880
"delete": {
614881
"description": "Returns success",

0 commit comments

Comments
 (0)