|
49 | 49 | "type": "string" |
50 | 50 | } |
51 | 51 | }, |
52 | | - "cursor": { |
53 | | - "description": "A pagination cursor is returned on the first call of the pagination process. If given, it will start from the end of the previous position. If not given, a new pagination is started.", |
54 | | - "in": "query", |
55 | | - "name": "cursor", |
56 | | - "schema": { |
57 | | - "type": "string" |
58 | | - } |
59 | | - }, |
60 | 52 | "limit": { |
61 | 53 | "description": "The maximum number of projects to return in the response. If not present, an appropriate default will be used. If maximum is exceeded, maximum is used.", |
62 | 54 | "in": "query", |
|
122 | 114 | "title": "CreateProjectRequest", |
123 | 115 | "type": "object" |
124 | 116 | }, |
125 | | - "Cursor": { |
126 | | - "description": "A pagination cursor is returned on the first call of the pagination process. If given, it will start from the end of the previous position. If not given, a new pagination is started.", |
127 | | - "example": "string", |
128 | | - "title": "cursor", |
129 | | - "type": "string" |
130 | | - }, |
131 | 117 | "ErrorResponse": { |
132 | 118 | "properties": { |
133 | 119 | "error": { |
|
167 | 153 | "title": "ErrorResponse", |
168 | 154 | "type": "object" |
169 | 155 | }, |
170 | | - "FolderResponse": { |
171 | | - "properties": { |
172 | | - "containerId": { |
173 | | - "description": "Globally unique, user-friendly identifier.", |
174 | | - "example": "first-folder-158955", |
175 | | - "type": "string" |
176 | | - }, |
177 | | - "creationTime": { |
178 | | - "description": "Timestamp at which the folder was created.", |
179 | | - "example": "2021-08-24T14:15:22Z", |
180 | | - "format": "date-time", |
181 | | - "type": "string" |
182 | | - }, |
183 | | - "folderId": { |
184 | | - "description": "Globally unique folder identifier.", |
185 | | - "example": "54066bf4-1aff-4f7b-9f83-fb23c348fff3", |
186 | | - "format": "uuid", |
187 | | - "type": "string" |
188 | | - }, |
189 | | - "labels": { |
190 | | - "$ref": "#/components/schemas/Labels" |
191 | | - }, |
192 | | - "name": { |
193 | | - "description": "Folder name.", |
194 | | - "example": "First Folder", |
195 | | - "type": "string" |
196 | | - }, |
197 | | - "parent": { |
198 | | - "$ref": "#/components/schemas/Parent" |
199 | | - }, |
200 | | - "updateTime": { |
201 | | - "description": "Timestamp at which the folder was last modified.", |
202 | | - "example": "2021-08-24T14:15:22Z", |
203 | | - "format": "date-time", |
204 | | - "type": "string" |
205 | | - } |
206 | | - }, |
207 | | - "required": [ |
208 | | - "name", |
209 | | - "containerId", |
210 | | - "folderId", |
211 | | - "creationTime", |
212 | | - "updateTime", |
213 | | - "parent" |
214 | | - ], |
215 | | - "title": "FolderResponse", |
216 | | - "type": "object" |
217 | | - }, |
218 | 156 | "GetProjectResponse": { |
219 | 157 | "properties": { |
220 | 158 | "containerId": { |
|
299 | 237 | "title": "Limit", |
300 | 238 | "type": "number" |
301 | 239 | }, |
302 | | - "ListOrganizationContainersResponse": { |
303 | | - "properties": { |
304 | | - "cursor": { |
305 | | - "$ref": "#/components/schemas/Cursor" |
306 | | - }, |
307 | | - "items": { |
308 | | - "items": { |
309 | | - "anyOf": [ |
310 | | - { |
311 | | - "properties": { |
312 | | - "item": { |
313 | | - "$ref": "#/components/schemas/FolderResponse" |
314 | | - }, |
315 | | - "type": { |
316 | | - "description": "Resource container type.", |
317 | | - "enum": [ |
318 | | - "FOLDER" |
319 | | - ], |
320 | | - "example": "FOLDER", |
321 | | - "type": "string" |
322 | | - } |
323 | | - }, |
324 | | - "required": [ |
325 | | - "type", |
326 | | - "item" |
327 | | - ] |
328 | | - }, |
329 | | - { |
330 | | - "properties": { |
331 | | - "item": { |
332 | | - "$ref": "#/components/schemas/Project" |
333 | | - }, |
334 | | - "type": { |
335 | | - "description": "Resource container type.", |
336 | | - "enum": [ |
337 | | - "PROJECT" |
338 | | - ], |
339 | | - "example": "PROJECT", |
340 | | - "type": "string" |
341 | | - } |
342 | | - }, |
343 | | - "required": [ |
344 | | - "type", |
345 | | - "item" |
346 | | - ] |
347 | | - } |
348 | | - ], |
349 | | - "type": "object" |
350 | | - }, |
351 | | - "type": "array" |
352 | | - }, |
353 | | - "limit": { |
354 | | - "$ref": "#/components/schemas/Limit" |
355 | | - } |
356 | | - }, |
357 | | - "required": [ |
358 | | - "limit", |
359 | | - "cursor", |
360 | | - "items" |
361 | | - ], |
362 | | - "title": "ListOrganizationContainersResponse", |
363 | | - "type": "object" |
364 | | - }, |
365 | 240 | "ListOrganizationsResponse": { |
366 | 241 | "properties": { |
367 | 242 | "items": { |
|
696 | 571 | }, |
697 | 572 | "openapi": "3.0.3", |
698 | 573 | "paths": { |
699 | | - "/bff/folders/{id}/containers": { |
700 | | - "get": { |
701 | | - "description": "Returns all direct resource container under this folder including their metadata. \n- Response items will contain all folders first, followed by all projects\n- If a folder does not have any containers, an empty items list will be returned\n\n**Note:** Recursion is not supported - meaning only the next level in hierarchy tree is considered!", |
702 | | - "operationId": "bff-get-containers-of-a-folder", |
703 | | - "parameters": [ |
704 | | - { |
705 | | - "$ref": "#/components/parameters/limit" |
706 | | - }, |
707 | | - { |
708 | | - "$ref": "#/components/parameters/cursor" |
709 | | - } |
710 | | - ], |
711 | | - "responses": { |
712 | | - "200": { |
713 | | - "content": { |
714 | | - "application/json": { |
715 | | - "schema": { |
716 | | - "$ref": "#/components/schemas/ListOrganizationContainersResponse" |
717 | | - } |
718 | | - } |
719 | | - }, |
720 | | - "description": "OK" |
721 | | - }, |
722 | | - "400": { |
723 | | - "content": { |
724 | | - "application/json": { |
725 | | - "schema": { |
726 | | - "$ref": "#/components/schemas/ErrorResponse" |
727 | | - } |
728 | | - } |
729 | | - }, |
730 | | - "description": "Malformed input" |
731 | | - }, |
732 | | - "401": { |
733 | | - "content": { |
734 | | - "application/json": { |
735 | | - "schema": { |
736 | | - "$ref": "#/components/schemas/ErrorResponse" |
737 | | - } |
738 | | - } |
739 | | - }, |
740 | | - "description": "Unauthorized" |
741 | | - } |
742 | | - }, |
743 | | - "summary": "Get Containers Of A Folder", |
744 | | - "x-stackit-authorization": { |
745 | | - "actions": [ |
746 | | - "resource-manager.folder.get" |
747 | | - ], |
748 | | - "resource-id": "id", |
749 | | - "resource-id-type": "dynamic", |
750 | | - "resource-type": "folder" |
751 | | - } |
752 | | - }, |
753 | | - "parameters": [ |
754 | | - { |
755 | | - "description": "Folder identifier - UUID identifier is preferred; containerId is also supported.", |
756 | | - "in": "path", |
757 | | - "name": "id", |
758 | | - "required": true, |
759 | | - "schema": { |
760 | | - "type": "string" |
761 | | - } |
762 | | - } |
763 | | - ] |
764 | | - }, |
765 | | - "/bff/organizations/{id}/containers": { |
766 | | - "get": { |
767 | | - "description": "Returns all direct resource container under this organization including their metadata.\n- Response items will contain all folders first, followed by all projects\n- If organization does not have any containers, an empty items list will be returned", |
768 | | - "operationId": "bff-get-containers-of-an-organization", |
769 | | - "parameters": [ |
770 | | - { |
771 | | - "$ref": "#/components/parameters/limit" |
772 | | - }, |
773 | | - { |
774 | | - "$ref": "#/components/parameters/cursor" |
775 | | - } |
776 | | - ], |
777 | | - "responses": { |
778 | | - "200": { |
779 | | - "content": { |
780 | | - "application/json": { |
781 | | - "schema": { |
782 | | - "$ref": "#/components/schemas/ListOrganizationContainersResponse" |
783 | | - } |
784 | | - } |
785 | | - }, |
786 | | - "description": "OK" |
787 | | - }, |
788 | | - "400": { |
789 | | - "content": { |
790 | | - "application/json": { |
791 | | - "schema": { |
792 | | - "$ref": "#/components/schemas/ErrorResponse" |
793 | | - } |
794 | | - } |
795 | | - }, |
796 | | - "description": "Malformed input" |
797 | | - }, |
798 | | - "401": { |
799 | | - "content": { |
800 | | - "application/json": { |
801 | | - "schema": { |
802 | | - "$ref": "#/components/schemas/ErrorResponse" |
803 | | - } |
804 | | - } |
805 | | - }, |
806 | | - "description": "Unauthorized" |
807 | | - }, |
808 | | - "404": { |
809 | | - "content": { |
810 | | - "application/json": { |
811 | | - "examples": { |
812 | | - "Organization Not Found": { |
813 | | - "$ref": "#/components/examples/NotFound" |
814 | | - } |
815 | | - }, |
816 | | - "schema": { |
817 | | - "$ref": "#/components/schemas/ErrorResponse" |
818 | | - } |
819 | | - } |
820 | | - }, |
821 | | - "description": "Organization Not Found" |
822 | | - } |
823 | | - }, |
824 | | - "summary": "Get Containers Of An Organization", |
825 | | - "x-stackit-authorization": { |
826 | | - "disabled": true |
827 | | - } |
828 | | - }, |
829 | | - "parameters": [ |
830 | | - { |
831 | | - "description": "Organization identifier - UUID identifier is preferred; containerId is also supported.", |
832 | | - "in": "path", |
833 | | - "name": "id", |
834 | | - "required": true, |
835 | | - "schema": { |
836 | | - "type": "string" |
837 | | - } |
838 | | - } |
839 | | - ] |
840 | | - }, |
841 | 574 | "/v2/organizations": { |
842 | 575 | "get": { |
843 | 576 | "description": "Returns all organizations and their metadata.\n- If no containerIds are specified, all organizations are returned, if permitted\n- ContainerIds may be set to filter\n- Member may be set to filter\n- If member and containerIds are given, both are used for filtering\n", |
|
0 commit comments