From 2a6e798da87f804448132b198059a11b6d98cbb4 Mon Sep 17 00:00:00 2001 From: jopemachine Date: Mon, 3 Feb 2025 05:23:38 +0000 Subject: [PATCH] chore: update api schema dump Co-authored-by: octodog --- docs/manager/rest-reference/openapi.json | 366 +++++++++++++++++++---- 1 file changed, 306 insertions(+), 60 deletions(-) diff --git a/docs/manager/rest-reference/openapi.json b/docs/manager/rest-reference/openapi.json index effd504ca3..336f51d482 100644 --- a/docs/manager/rest-reference/openapi.json +++ b/docs/manager/rest-reference/openapi.json @@ -20,44 +20,303 @@ } }, "schemas": { - "AssociationRequestModel": { + "AllowedGroupsModel": { "properties": { - "registry_id": { - "description": "Container registry row's ID", - "title": "Registry Id", - "type": "string" + "add": { + "default": [], + "items": { + "type": "string" + }, + "title": "Add", + "type": "array" }, - "group_id": { - "description": "Group row's ID", - "title": "Group Id", - "type": "string" + "remove": { + "default": [], + "items": { + "type": "string" + }, + "title": "Remove", + "type": "array" } }, - "required": [ - "registry_id", - "group_id" - ], - "title": "AssociationRequestModel", + "title": "AllowedGroupsModel", "type": "object" }, - "DisassociationRequestModel": { + "ContainerRegistryType": { + "enum": [ + "docker", + "harbor", + "harbor2", + "github", + "gitlab", + "ecr", + "ecr-public", + "local" + ], + "title": "ContainerRegistryType", + "type": "string" + }, + "PatchContainerRegistryRequestModel": { "properties": { - "registry_id": { - "description": "Container registry row's ID", - "title": "Registry Id", - "type": "string" + "id": { + "anyOf": [ + { + "format": "uuid", + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Id" }, - "group_id": { - "description": "Group row's ID", - "title": "Group Id", - "type": "string" + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Url" + }, + "registry_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Registry Name" + }, + "type": { + "anyOf": [ + { + "$ref": "#/components/schemas/ContainerRegistryType" + }, + { + "type": "null" + } + ], + "default": null + }, + "project": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Project" + }, + "username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Username" + }, + "password": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Password" + }, + "ssl_verify": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Ssl Verify" + }, + "is_global": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Is Global" + }, + "extra": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Extra" + }, + "allowed_groups": { + "anyOf": [ + { + "$ref": "#/components/schemas/AllowedGroupsModel" + }, + { + "type": "null" + } + ], + "default": null } }, - "required": [ - "registry_id", - "group_id" - ], - "title": "DisassociationRequestModel", + "title": "PatchContainerRegistryRequestModel", + "type": "object" + }, + "PatchContainerRegistryResponseModel": { + "properties": { + "id": { + "anyOf": [ + { + "format": "uuid", + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Id" + }, + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Url" + }, + "registry_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Registry Name" + }, + "type": { + "anyOf": [ + { + "$ref": "#/components/schemas/ContainerRegistryType" + }, + { + "type": "null" + } + ], + "default": null + }, + "project": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Project" + }, + "username": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Username" + }, + "password": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Password" + }, + "ssl_verify": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Ssl Verify" + }, + "is_global": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Is Global" + }, + "extra": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Extra" + } + }, + "title": "PatchContainerRegistryResponseModel", "type": "object" }, "VFolderPermission": { @@ -1258,15 +1517,22 @@ "description": "\n**Preconditions:**\n* User privilege required.\n* Manager status required: RUNNING\n" } }, - "/container-registries/associate-with-group": { - "post": { - "operationId": "container-registries.associate_with_group", + "/container-registries/{registry_id}": { + "patch": { + "operationId": "container-registries.patch_container_registry", "tags": [ "container-registries" ], "responses": { "200": { - "description": "Successful response" + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchContainerRegistryResponseModel" + } + } + } } }, "security": [ @@ -1278,41 +1544,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AssociationRequestModel" + "$ref": "#/components/schemas/PatchContainerRegistryRequestModel" } } } }, - "parameters": [], - "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: one of FROZEN, RUNNING\n" - } - }, - "/container-registries/disassociate-with-group": { - "post": { - "operationId": "container-registries.disassociate_with_group", - "tags": [ - "container-registries" - ], - "responses": { - "200": { - "description": "Successful response" - } - }, - "security": [ + "parameters": [ { - "TokenAuth": [] - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DisassociationRequestModel" - } + "name": "registry_id", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, - "parameters": [], + ], "description": "\n**Preconditions:**\n* Superadmin privilege required.\n* Manager status required: one of FROZEN, RUNNING\n" } },