Skip to content

Commit

Permalink
OAS Update
Browse files Browse the repository at this point in the history
  • Loading branch information
@stackit-pipeline
stackit-pipeline committed Oct 21, 2024
1 parent 1995bd7 commit 900be85
Showing 1 changed file with 256 additions and 0 deletions.
256 changes: 256 additions & 0 deletions services/resource-manager/v0/resource-manager.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@
"type": "string"
}
},
"cursor": {
"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.",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
},
"limit": {
"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.",
"in": "query",
Expand Down Expand Up @@ -114,6 +122,12 @@
"title": "CreateProjectRequest",
"type": "object"
},
"Cursor": {
"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.",
"example": "string",
"title": "cursor",
"type": "string"
},
"ErrorResponse": {
"properties": {
"error": {
Expand Down Expand Up @@ -153,6 +167,54 @@
"title": "ErrorResponse",
"type": "object"
},
"FolderResponse": {
"properties": {
"containerId": {
"description": "Globally unique, user-friendly identifier.",
"example": "first-folder-158955",
"type": "string"
},
"creationTime": {
"description": "Timestamp at which the folder was created.",
"example": "2021-08-24T14:15:22Z",
"format": "date-time",
"type": "string"
},
"folderId": {
"description": "Globally unique folder identifier.",
"example": "54066bf4-1aff-4f7b-9f83-fb23c348fff3",
"format": "uuid",
"type": "string"
},
"labels": {
"$ref": "#/components/schemas/Labels"
},
"name": {
"description": "Folder name.",
"example": "First Folder",
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/Parent"
},
"updateTime": {
"description": "Timestamp at which the folder was last modified.",
"example": "2021-08-24T14:15:22Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"containerId",
"folderId",
"creationTime",
"updateTime",
"parent"
],
"title": "FolderResponse",
"type": "object"
},
"GetProjectResponse": {
"properties": {
"containerId": {
Expand Down Expand Up @@ -237,6 +299,69 @@
"title": "Limit",
"type": "number"
},
"ListOrganizationContainersResponse": {
"properties": {
"cursor": {
"$ref": "#/components/schemas/Cursor"
},
"items": {
"items": {
"anyOf": [
{
"properties": {
"item": {
"$ref": "#/components/schemas/FolderResponse"
},
"type": {
"description": "Resource container type.",
"enum": [
"FOLDER"
],
"example": "FOLDER",
"type": "string"
}
},
"required": [
"type",
"item"
]
},
{
"properties": {
"item": {
"$ref": "#/components/schemas/Project"
},
"type": {
"description": "Resource container type.",
"enum": [
"PROJECT"
],
"example": "PROJECT",
"type": "string"
}
},
"required": [
"type",
"item"
]
}
],
"type": "object"
},
"type": "array"
},
"limit": {
"$ref": "#/components/schemas/Limit"
}
},
"required": [
"limit",
"cursor",
"items"
],
"title": "ListOrganizationContainersResponse",
"type": "object"
},
"ListOrganizationsResponse": {
"properties": {
"items": {
Expand Down Expand Up @@ -571,6 +696,137 @@
},
"openapi": "3.0.3",
"paths": {
"/bff/folders/{id}/containers": {
"get": {
"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!",
"operationId": "bff-get-containers-of-a-folder",
"parameters": [
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/cursor"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrganizationContainersResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Malformed input"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Get Containers Of A Folder"
},
"parameters": [
{
"description": "Folder identifier - UUID identifier is preferred; containerId is also supported.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/bff/organizations/{id}/containers": {
"get": {
"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",
"operationId": "bff-get-containers-of-an-organization",
"parameters": [
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/cursor"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrganizationContainersResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Malformed input"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"examples": {
"Organization Not Found": {
"$ref": "#/components/examples/NotFound"
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Organization Not Found"
}
},
"summary": "Get Containers Of An Organization"
},
"parameters": [
{
"description": "Organization identifier - UUID identifier is preferred; containerId is also supported.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/v2/organizations": {
"get": {
"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",
Expand Down

0 comments on commit 900be85

Please sign in to comment.