OAS Update

Author: stackit-pipeline

services/ufw/v1/ufw.json

@@ -730,7 +730,110 @@
   },
   "openapi": "3.0.3",
   "paths": {
-    "/v1/folder/{folderId}/regions/{regionId}/rules/export": {
+    "/v1/folders/{folderId}/children": {
+      "get": {
+        "description": "Returns a list of containers for a specific folder",
+        "operationId": "v1-get-folder-resources",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/folderId"
+          },
+          {
+            "$ref": "#/components/parameters/limit"
+          },
+          {
+            "$ref": "#/components/parameters/cursor"
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ListContainersResponse"
+                }
+              }
+            },
+            "description": "Successful response"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Bad request"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden access. You are not allowed to get rules from this project."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Folder not found."
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Service is not available."
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Service is not available."
+          }
+        },
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "summary": "Get containers from a folder",
+        "x-stackit-authorization": {
+          "actions": [
+            "ufw.folder.list"
+          ],
+          "resource-id": "folderId",
+          "resource-id-type": "dynamic",
+          "resource-type": "folder"
+        }
+      }
+    },
+    "/v1/folders/{folderId}/regions/{regionId}/rules/export": {
       "get": {
         "description": "Returns a CSV file containing the rules for a specific folder",
         "operationId": "v1-export-folder-rules",
@@ -825,13 +928,13 @@
         }
       }
     },
-    "/v1/folders/{folderId}/children": {
+    "/v1/organizations/{organizationId}/children": {
       "get": {
-        "description": "Returns a list of containers for a specific folder",
-        "operationId": "v1-get-folder-resources",
+        "description": "Returns a list of containers for a specific organization",
+        "operationId": "v1-get-organization-resources",
         "parameters": [
           {
-            "$ref": "#/components/parameters/folderId"
+            "$ref": "#/components/parameters/organizationId"
           },
           {
             "$ref": "#/components/parameters/limit"
@@ -879,7 +982,7 @@
                 }
               }
             },
-            "description": "Forbidden access. You are not allowed to get rules from this project."
+            "description": "Forbidden access. You are not allowed to get containers from this folder."
           },
           "404": {
             "content": {
@@ -917,42 +1020,43 @@
             "BearerAuth": []
           }
         ],
-        "summary": "Get containers from a folder",
+        "summary": "Get containers from an organization",
         "x-stackit-authorization": {
           "actions": [
-            "ufw.folder.list"
+            "ufw.organization.list"
           ],
-          "resource-id": "folderId",
+          "resource-id": "organizationId",
           "resource-id-type": "dynamic",
-          "resource-type": "folder"
+          "resource-type": "organization"
         }
       }
     },
-    "/v1/organizations/{organizationId}/children": {
+    "/v1/organizations/{organizationId}/regions/{regionId}/rules/export": {
       "get": {
-        "description": "Returns a list of containers for a specific organization",
-        "operationId": "v1-get-organization-resources",
+        "description": "Returns a CSV file containing the rules for a specific organization",
+        "operationId": "v1-export-organization-rules",
         "parameters": [
           {
             "$ref": "#/components/parameters/organizationId"
           },
           {
-            "$ref": "#/components/parameters/limit"
+            "$ref": "#/components/parameters/regionId"
           },
           {
-            "$ref": "#/components/parameters/cursor"
+            "$ref": "#/components/parameters/ruleFilters"
           }
         ],
         "responses": {
           "200": {
             "content": {
-              "application/json": {
+              "text/csv": {
                 "schema": {
-                  "$ref": "#/components/schemas/ListContainersResponse"
+                  "format": "binary",
+                  "type": "string"
                 }
               }
             },
-            "description": "Successful response"
+            "description": "Successful CSV file download"
           },
           "400": {
             "content": {
@@ -982,7 +1086,7 @@
                 }
               }
             },
-            "description": "Forbidden access. You are not allowed to get containers from this folder."
+            "description": "Forbidden access. You are not allowed to get rules from this organization."
           },
           "404": {
             "content": {
@@ -992,7 +1096,7 @@
                 }
               }
             },
-            "description": "Folder not found."
+            "description": "Project not found."
           },
           "500": {
             "content": {
@@ -1003,26 +1107,17 @@
               }
             },
             "description": "Service is not available."
-          },
-          "503": {
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponse"
-                }
-              }
-            },
-            "description": "Service is not available."
           }
         },
         "security": [
           {
             "BearerAuth": []
           }
         ],
-        "summary": "Get containers from an organization",
+        "summary": "Export rules for organization as CSV",
         "x-stackit-authorization": {
           "actions": [
+            "ufw.instance.list",
             "ufw.organization.list"
           ],
           "resource-id": "organizationId",