{ "openapi": "3.0.0", "info": { "title": "public/portworx/platform/targetclusterregistrationmanifest/apiv1/targetclusterregistrationmanifest.proto", "version": "version not set" }, "tags": [ { "name": "TargetClusterRegistrationManifestService" } ], "paths": { "/core/v1/clusters/{clusterId}:reregister": { "post": { "summary": "ReRegisterTargetCluster fetches manifest for re-registration of target cluster.", "operationId": "TargetClusterRegistrationManifestService_ReRegisterTargetCluster", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TargetClusterRegistrationManifest" } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "clusterId", "description": "cluster ID is the id of the target cluster already registered with control plane.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetClusterRegistrationManifestServiceReRegisterTargetClusterBody" } } }, "required": true }, "tags": [ "TargetClusterRegistrationManifestService" ] } }, "/core/v1/tenants/{tenantId}:registrationManifests": { "post": { "summary": "GetTargetClusterRegistrationManifest fetches registration manifest for the given request under specified Tenant (Organization).", "operationId": "TargetClusterRegistrationManifestService_GenerateTargetClusterRegistrationManifest", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TargetClusterRegistrationManifest" } } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "tenantId", "description": "tenanat_id is the id of the Tenant (Organization) for which manifest is requested.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetClusterRegistrationManifestServiceGenerateTargetClusterRegistrationManifestBody" } } }, "required": true }, "tags": [ "TargetClusterRegistrationManifestService" ] } } }, "components": { "schemas": { "TargetClusterRegistrationManifestServiceGenerateTargetClusterRegistrationManifestBody": { "type": "object", "properties": { "clusterName": { "type": "string", "description": "cluster_name which the user wants to use." }, "config": { "$ref": "#/components/schemas/v1Config" } }, "description": "GetTargetClusterRegistrationManifestRequest is the request message to the GetTargetClusterRegistrationManifest API." }, "TargetClusterRegistrationManifestServiceReRegisterTargetClusterBody": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/v1Config" } }, "description": "ReRegisterTargetClusterRequest is the request message to the ReRegisterTargetCluster API." }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny" } } } }, "v1Config": { "type": "object", "properties": { "customImageRegistryConfig": { "$ref": "#/components/schemas/v1CustomImageRegistryConfig" }, "proxyConfig": { "$ref": "#/components/schemas/v1ProxyConfig" } }, "description": "Configuration of the target cluster registration manifest." }, "v1CustomImageRegistryConfig": { "type": "object", "properties": { "registryUrl": { "type": "string", "description": "registry url/domain, e.g. - in org.example.com/namespace/sub-namespace/repo:tag, here `org.example.com` is\nthe registry url." }, "registryNamespace": { "type": "string", "description": "registry namespace, e.g. - in org.example.com/namespace/sub-namespace/repo:tag, here `namespace/sub-namespace` is\nthe registry namespace." }, "username": { "type": "string", "description": "username for authenticating to a private registry." }, "password": { "type": "string", "description": "password for authenticating to a private registry." }, "caCert": { "type": "string", "description": "ca cert of the registry server." } }, "description": "CustomImageRegistryConfig holds image registry credential configs." }, "v1ProxyConfig": { "type": "object", "properties": { "httpUrl": { "type": "string", "description": "http proxy url with port, e.g. - http://192.168.0.1:1234." }, "httpsUrl": { "type": "string", "description": "https proxy url with port, e.g. - https://192.168.0.1:4567." }, "username": { "type": "string", "description": "username for authenticating to the proxy server." }, "password": { "type": "string", "description": "password for authenticating to the proxy server." }, "noProxy": { "type": "string", "description": "comma separated no proxy urls list, e.g. - 127.0.0.1,localhost,.svc,192.168.0.1/16,github.com,KUBERNETES_SERVICE_HOST." }, "caCert": { "type": "string", "description": "ca cert of the proxy server." } }, "description": "ProxyConfig holds proxy configs." }, "v1TargetClusterRegistrationManifest": { "type": "object", "properties": { "manifest": { "type": "string", "description": "manifest contains the yaml string of the registration manifest." } }, "description": "TargetClusterRegistrationManifest is the response message of the GetTargetClusterRegistrationManifest API." } } } }