From 312dc82abe8784b8a67e400c96a1450685cd4e0e Mon Sep 17 00:00:00 2001 From: nirav-rafay Date: Thu, 17 Nov 2022 07:36:17 +0000 Subject: [PATCH] deploy: f93cdd0549574a7903eb14293995080bf0cb0c61 --- apis/account_permission.swagger.json | 43 + apis/artifacts.swagger.json | 43 + apis/audit_info.swagger.json | 189 ++ apis/auditlog.swagger.json | 571 +++++ apis/auth.swagger.json | 236 ++ apis/authz.swagger.json | 43 + apis/bootstrap.swagger.json | 2493 ++++++++++++++++++ apis/cluster.swagger.json | 2794 +++++++++++++++++++++ apis/cluster_authz.swagger.json | 399 +++ apis/cluster_controller.swagger.json | 43 + apis/common.swagger.json | 43 + apis/group.swagger.json | 1234 +++++++++ apis/group_permission.swagger.json | 43 + apis/idp.swagger.json | 1042 ++++++++ apis/kubeconfig.swagger.json | 2572 +++++++++++++++++++ apis/kubeconfig_setting.swagger.json | 43 + apis/kubectl_cluster.swagger.json | 595 +++++ apis/kubectl_cluster_setting.swagger.json | 43 + apis/metro.swagger.json | 1352 ++++++++++ apis/namespace.swagger.json | 43 + apis/oidc_provider.swagger.json | 1036 ++++++++ apis/organization.swagger.json | 1586 ++++++++++++ apis/partner.swagger.json | 1019 ++++++++ apis/project.swagger.json | 1185 +++++++++ apis/relayaudit.swagger.json | 1003 ++++++++ apis/relaypeer.swagger.json | 94 + apis/role.swagger.json | 1205 +++++++++ apis/rolepermission.swagger.json | 526 ++++ apis/sentry.swagger.json | 43 + apis/test.swagger.json | 113 + apis/user.swagger.json | 1772 +++++++++++++ swagger-config.json | 2 +- 32 files changed, 23447 insertions(+), 1 deletion(-) create mode 100644 apis/account_permission.swagger.json create mode 100644 apis/artifacts.swagger.json create mode 100644 apis/audit_info.swagger.json create mode 100644 apis/auditlog.swagger.json create mode 100644 apis/auth.swagger.json create mode 100644 apis/authz.swagger.json create mode 100644 apis/bootstrap.swagger.json create mode 100644 apis/cluster.swagger.json create mode 100644 apis/cluster_authz.swagger.json create mode 100644 apis/cluster_controller.swagger.json create mode 100644 apis/common.swagger.json create mode 100644 apis/group.swagger.json create mode 100644 apis/group_permission.swagger.json create mode 100644 apis/idp.swagger.json create mode 100644 apis/kubeconfig.swagger.json create mode 100644 apis/kubeconfig_setting.swagger.json create mode 100644 apis/kubectl_cluster.swagger.json create mode 100644 apis/kubectl_cluster_setting.swagger.json create mode 100644 apis/metro.swagger.json create mode 100644 apis/namespace.swagger.json create mode 100644 apis/oidc_provider.swagger.json create mode 100644 apis/organization.swagger.json create mode 100644 apis/partner.swagger.json create mode 100644 apis/project.swagger.json create mode 100644 apis/relayaudit.swagger.json create mode 100644 apis/relaypeer.swagger.json create mode 100644 apis/role.swagger.json create mode 100644 apis/rolepermission.swagger.json create mode 100644 apis/sentry.swagger.json create mode 100644 apis/test.swagger.json create mode 100644 apis/user.swagger.json diff --git a/apis/account_permission.swagger.json b/apis/account_permission.swagger.json new file mode 100644 index 0000000..4e56769 --- /dev/null +++ b/apis/account_permission.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/sentry/account_permission.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/artifacts.swagger.json b/apis/artifacts.swagger.json new file mode 100644 index 0000000..3d94cae --- /dev/null +++ b/apis/artifacts.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/commonpb/v3/artifacts.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/audit_info.swagger.json b/apis/audit_info.swagger.json new file mode 100644 index 0000000..50e2aa0 --- /dev/null +++ b/apis/audit_info.swagger.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "title": "Sentry Audit Information Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "AuditInformationService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/v2/sentry/auditInfo/cluster": { + "get": { + "operationId": "AuditInformationService_LookupCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcLookupClusterResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "clusterSNI", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "AuditInformationService" + ] + } + }, + "/v2/sentry/auditInfo/user": { + "get": { + "operationId": "AuditInformationService_LookupUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcLookupUserResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "userCN", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "AuditInformationService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcLookupClusterResponse": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + } + } + }, + "rpcLookupUserResponse": { + "type": "object", + "properties": { + "userName": { + "type": "string" + }, + "accountID": { + "type": "string" + }, + "isSSO": { + "type": "string" + }, + "organizationID": { + "type": "string" + }, + "partnerID": { + "type": "string" + }, + "sessionType": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/auditlog.swagger.json b/apis/auditlog.swagger.json new file mode 100644 index 0000000..d1fa9e1 --- /dev/null +++ b/apis/auditlog.swagger.json @@ -0,0 +1,571 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuditLog Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "AuditLogService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/event/v1/auditlog": { + "get": { + "operationId": "AuditLogService_GetAuditLogByProjects", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1GetAuditLogSearchResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "tags": [ + "AuditLogService" + ] + } + }, + "/event/v1/{metadata.urlScope}/auditlog": { + "get": { + "operationId": "AuditLogService_GetAuditLog", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1GetAuditLogSearchResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.urlScope", + "in": "path", + "required": true, + "type": "string", + "pattern": "project/[^/]+" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "tags": [ + "AuditLogService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "protobufNullValue": { + "type": "string", + "enum": [ + "NULL_VALUE" + ], + "default": "NULL_VALUE", + "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." + }, + "v1AuditLogQueryFilter": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "user": { + "type": "string" + }, + "client": { + "type": "string" + }, + "timefrom": { + "type": "string" + }, + "portal": { + "type": "string" + }, + "cluster": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "method": { + "type": "string" + }, + "projects": { + "type": "array", + "items": { + "type": "string" + } + }, + "queryString": { + "type": "string" + }, + "dashboardData": { + "type": "boolean" + } + } + }, + "v1GetAuditLogSearchResponse": { + "type": "object", + "properties": { + "result": { + "type": "object" + } + } + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/auth.swagger.json b/apis/auth.swagger.json new file mode 100644 index 0000000..86bcbfd --- /dev/null +++ b/apis/auth.swagger.json @@ -0,0 +1,236 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/rpc/v3/auth.proto", + "version": "version not set" + }, + "tags": [ + { + "name": "AuthService" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "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": "#/definitions/protobufAny" + } + } + } + }, + "v3AuthType": { + "type": "string", + "enum": [ + "AuthTypeNotSet", + "SessionLogin", + "APIKey" + ], + "default": "AuthTypeNotSet" + }, + "v3ClientType": { + "type": "string", + "enum": [ + "ClientTypeNotSet", + "BROWSER", + "CLI" + ], + "default": "ClientTypeNotSet" + }, + "v3IsRequestAllowedResponse": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/v3RequestStatus" + }, + "reason": { + "type": "string" + }, + "sessionData": { + "$ref": "#/definitions/v3SessionData" + } + } + }, + "v3NamespaceData": { + "type": "object", + "properties": { + "projectId": { + "type": "string" + }, + "namespaceId": { + "type": "string" + }, + "role": { + "type": "string" + } + } + }, + "v3ProjectData": { + "type": "object", + "properties": { + "all": { + "type": "boolean" + }, + "list": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ProjectRole" + } + } + } + }, + "v3ProjectRole": { + "type": "object", + "properties": { + "project": { + "type": "string" + }, + "projectId": { + "type": "string" + }, + "role": { + "type": "string" + } + } + }, + "v3RequestStatus": { + "type": "string", + "enum": [ + "Unknown", + "RequestNotAuthenticated", + "RequestMethodOrURLNotAllowed", + "RequestAllowed" + ], + "default": "Unknown" + }, + "v3ResourceURLMethods": { + "type": "object", + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "Remove unnecessary fields" + }, + "v3SessionData": { + "type": "object", + "properties": { + "account": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "partner": { + "type": "string" + }, + "role": { + "type": "string" + }, + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "partnerDomain": { + "type": "string" + }, + "username": { + "type": "string" + }, + "isSuperAdmin": { + "type": "boolean" + }, + "isPartnerAdmin": { + "type": "boolean" + }, + "isSsoUser": { + "type": "boolean" + }, + "resourceUrls": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/v3ResourceURLMethods" + } + }, + "ttl": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "authType": { + "$ref": "#/definitions/v3AuthType" + }, + "idp": { + "type": "string" + }, + "isOrgAdmin": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + }, + "clientType": { + "$ref": "#/definitions/v3ClientType" + }, + "clientHost": { + "type": "string" + }, + "clientIp": { + "type": "string" + }, + "clientUa": { + "type": "string" + }, + "isAllNsAccess": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + }, + "namespaces": { + "type": "array", + "items": { + "$ref": "#/definitions/v3NamespaceData" + } + }, + "project": { + "$ref": "#/definitions/v3ProjectData" + } + } + } + } +} diff --git a/apis/authz.swagger.json b/apis/authz.swagger.json new file mode 100644 index 0000000..36c51d3 --- /dev/null +++ b/apis/authz.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/authz/authz.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "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": "#/definitions/protobufAny" + } + } + } + } + } +} diff --git a/apis/bootstrap.swagger.json b/apis/bootstrap.swagger.json new file mode 100644 index 0000000..d1f000c --- /dev/null +++ b/apis/bootstrap.swagger.json @@ -0,0 +1,2493 @@ +{ + "swagger": "2.0", + "info": { + "title": "Sentry Bootstrap Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "BootstrapService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/v2/sentry/bootstrap/infra/{metadata.name}": { + "get": { + "operationId": "BootstrapService_GetBootstrapInfra", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapInfra" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "BootstrapInfra" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.caCert", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.caKey", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.caKeyPass", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + }, + "put": { + "operationId": "BootstrapService_PatchBootstrapInfra", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapInfra" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapInfra", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/sentryBootstrapInfraSpec" + }, + "status": { + "$ref": "#/definitions/sentryBootstrapInfraStatus" + } + }, + "required": [ + "project" + ] + } + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/template": { + "get": { + "operationId": "BootstrapService_GetBootstrapAgentTemplates", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/template/{metadata.name}": { + "get": { + "operationId": "BootstrapService_GetBootstrapAgentTemplate", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgentTemplate" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "BootstrapAgentTemplate" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.infraRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.autoRegister", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.ignoreMultipleRegister", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.autoApprove", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.templateType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "TemplateTypeNotSet", + "Client", + "Server", + "Mixed" + ], + "default": "TemplateTypeNotSet" + }, + { + "name": "spec.token", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.inClusterTemplate", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.outOfClusterTemplate", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + }, + "put": { + "operationId": "BootstrapService_PatchBootstrapAgentTemplate", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgentTemplate" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgentTemplate", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateSpec" + }, + "status": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateStatus" + } + }, + "required": [ + "project" + ] + } + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/{spec.templateRef}/agent": { + "post": { + "operationId": "BootstrapService_CreateBootstrapAgent", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgent" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "spec.templateRef", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgent", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "type": "object", + "properties": { + "token": { + "type": "string" + }, + "agentMode": { + "$ref": "#/definitions/sentryBootstrapAgentMode" + } + } + }, + "status": { + "$ref": "#/definitions/sentryBootStrapAgentStatus" + } + } + } + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/{spec.templateRef}/agent/{metadata.name}": { + "get": { + "operationId": "BootstrapService_GetBootstrapAgent", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgent" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "spec.templateRef", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "BootstrapAgent" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.token", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.agentMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "InCluster", + "OutOfCluster" + ], + "default": "InCluster" + }, + { + "name": "status.tokenState", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "NotSet", + "NotRegistered", + "NotApproved", + "Approved" + ], + "default": "NotSet" + }, + { + "name": "status.ipAddress", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.lastCheckedIn", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.fingerprint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + }, + "delete": { + "operationId": "BootstrapService_DeleteBootstrapAgent", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcDeleteBootstrapAgentResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "spec.templateRef", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "BootstrapAgent" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.token", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.agentMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "InCluster", + "OutOfCluster" + ], + "default": "InCluster" + }, + { + "name": "status.tokenState", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "NotSet", + "NotRegistered", + "NotApproved", + "Approved" + ], + "default": "NotSet" + }, + { + "name": "status.ipAddress", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.lastCheckedIn", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.fingerprint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + }, + "put": { + "operationId": "BootstrapService_UpdateBootstrapAgent", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgent" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "spec.templateRef", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgent", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "type": "object", + "properties": { + "token": { + "type": "string" + }, + "agentMode": { + "$ref": "#/definitions/sentryBootstrapAgentMode" + } + } + }, + "status": { + "$ref": "#/definitions/sentryBootStrapAgentStatus" + } + }, + "required": [ + "project" + ] + } + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/{spec.templateRef}/agent/{metadata.name}/config": { + "get": { + "operationId": "BootstrapService_GetBootstrapAgentConfig", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "spec.templateRef", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": false, + "type": "string", + "default": "BootstrapAgent" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.token", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.agentMode", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "InCluster", + "OutOfCluster" + ], + "default": "InCluster" + }, + { + "name": "status.tokenState", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "NotSet", + "NotRegistered", + "NotApproved", + "Approved" + ], + "default": "NotSet" + }, + { + "name": "status.ipAddress", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.lastCheckedIn", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.fingerprint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/{templateScope}/agent": { + "get": { + "operationId": "BootstrapService_GetBootstrapAgents", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sentryBootstrapAgentList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "templateScope", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "BootstrapService" + ] + } + }, + "/v2/sentry/bootstrap/{templateToken}/register": { + "post": { + "operationId": "BootstrapService_RegisterBootstrapAgent", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcRegisterAgentResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": {} + }, + "500": { + "description": "Returned for internal server error", + "schema": {} + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "templateToken", + "in": "path", + "required": true, + "type": "string", + "pattern": "template/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "templateName": { + "type": "string" + }, + "token": { + "type": "string" + }, + "csr": { + "type": "string", + "format": "byte" + }, + "ipAddress": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + ], + "tags": [ + "BootstrapService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcDeleteBootstrapAgentResponse": { + "type": "object" + }, + "rpcRegisterAgentResponse": { + "type": "object", + "properties": { + "certificate": { + "type": "string", + "format": "byte" + }, + "caCertificate": { + "type": "string", + "format": "byte" + } + } + }, + "sentryBootStrapAgentStatus": { + "type": "object", + "properties": { + "tokenState": { + "$ref": "#/definitions/sentryBootstrapAgentState" + }, + "ipAddress": { + "type": "string" + }, + "lastCheckedIn": { + "type": "string", + "format": "date-time" + }, + "fingerprint": { + "type": "string" + } + } + }, + "sentryBootstrapAgent": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgent", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/sentryBootstrapAgentSpec" + }, + "status": { + "$ref": "#/definitions/sentryBootStrapAgentStatus" + } + } + }, + "sentryBootstrapAgentList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgentList", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/sentryBootstrapAgent" + } + } + }, + "title": "BootstrapAgentList is a list of bootstrap agents" + }, + "sentryBootstrapAgentMode": { + "type": "string", + "enum": [ + "InCluster", + "OutOfCluster" + ], + "default": "InCluster" + }, + "sentryBootstrapAgentSpec": { + "type": "object", + "properties": { + "token": { + "type": "string" + }, + "templateRef": { + "type": "string" + }, + "agentMode": { + "$ref": "#/definitions/sentryBootstrapAgentMode" + } + } + }, + "sentryBootstrapAgentState": { + "type": "string", + "enum": [ + "NotSet", + "NotRegistered", + "NotApproved", + "Approved" + ], + "default": "NotSet" + }, + "sentryBootstrapAgentTemplate": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgentTemplate", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateSpec" + }, + "status": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateStatus" + } + } + }, + "sentryBootstrapAgentTemplateList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapAgentTemplateList", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/sentryBootstrapAgentTemplate" + } + } + } + }, + "sentryBootstrapAgentTemplateSpec": { + "type": "object", + "properties": { + "infraRef": { + "type": "string" + }, + "autoRegister": { + "type": "boolean" + }, + "ignoreMultipleRegister": { + "type": "boolean" + }, + "autoApprove": { + "type": "boolean" + }, + "templateType": { + "$ref": "#/definitions/sentryBootstrapAgentTemplateType" + }, + "token": { + "type": "string" + }, + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/sentryBootstrapTemplateHost" + } + }, + "inClusterTemplate": { + "type": "string" + }, + "outOfClusterTemplate": { + "type": "string" + } + } + }, + "sentryBootstrapAgentTemplateStatus": { + "type": "object" + }, + "sentryBootstrapAgentTemplateType": { + "type": "string", + "enum": [ + "TemplateTypeNotSet", + "Client", + "Server", + "Mixed" + ], + "default": "TemplateTypeNotSet" + }, + "sentryBootstrapInfra": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "BootstrapInfra", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/sentryBootstrapInfraSpec" + }, + "status": { + "$ref": "#/definitions/sentryBootstrapInfraStatus" + } + } + }, + "sentryBootstrapInfraSpec": { + "type": "object", + "properties": { + "caCert": { + "type": "string" + }, + "caKey": { + "type": "string" + }, + "caKeyPass": { + "type": "string" + } + } + }, + "sentryBootstrapInfraStatus": { + "type": "object" + }, + "sentryBootstrapTemplateHost": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/sentryBootstrapTemplateHostType" + } + } + }, + "sentryBootstrapTemplateHostType": { + "type": "string", + "enum": [ + "HostTypeNotSet", + "HostTypeInternal", + "HostTypeExternal" + ], + "default": "HostTypeNotSet" + }, + "v3HttpBody": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "The HTTP Content-Type header value specifying the content type of the body." + }, + "data": { + "type": "string", + "format": "byte", + "description": "The HTTP request/response body as raw binary." + } + }, + "title": "HttpBody represents arbitrary HTTP Body. It should only be used for\npayload formats that can't be represented as JSON" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3QueryOptions": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "urlScope": { + "type": "string", + "title": "urlScope is supposed to be passed in the URL as kind/HashID(value)" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/cluster.swagger.json b/apis/cluster.swagger.json new file mode 100644 index 0000000..e701d34 --- /dev/null +++ b/apis/cluster.swagger.json @@ -0,0 +1,2794 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cluster Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "ClusterService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/infra/v3/project/{metadata.project}/cluster": { + "post": { + "operationId": "ClusterService_CreateCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Cluster" + } + }, + "201": { + "description": "Returned when edge is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.project", + "description": "Project of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Cluster", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ClusterSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Cluster", + "title": "Cluster", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name" + ] + } + } + ], + "tags": [ + "ClusterService" + ] + } + }, + "/infra/v3/project/{metadata.project}/cluster/{metadata.name}": { + "get": { + "operationId": "ClusterService_GetCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Cluster" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.project", + "description": "Project of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Cluster" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.clusterType", + "description": "Cluster Type\n\nType of the cluster being created", + "in": "query", + "required": false, + "type": "string", + "default": "Imported" + }, + { + "name": "spec.metro.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.overrideSelector", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.environmentProvider", + "description": "EnvironmentProvider\n\nenvironment provider of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.kubernetesProvider", + "description": "KubernetesProvider\n\nkubernetes provider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionEnvironment", + "description": "ProvisionEnvironment\n\nprovision environment", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionPackageType", + "description": "ProvisionPackageType\n\nprovision package type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionType", + "description": "ProvisionType\n\nprovision type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.state", + "description": "State\n\nstate", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.shareMode", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ClusterShareModeNotSet", + "ALL", + "CUSTOM" + ], + "default": "ClusterShareModeNotSet" + }, + { + "name": "spec.proxyConfig.httpProxy", + "description": "HttpProxy\n\nhttp proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.httpsProxy", + "description": "HttpsProxy\n\nhttps proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.noProxy", + "description": "noproxy\n\nnoproxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.proxyAuth", + "description": "ProxyAuth\n\nproxy auth", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.allowInsecureBootstrap", + "description": "AllowInsecureBootstrap\n\nAllow insecure bootstrap", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.enabled", + "description": "Enabled\n\nenabled", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.bootstrapCA", + "description": "BootstrapCA\n\nCertificate Authority of bootstrap server", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.provider", + "description": "Provider\n\nProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.passphrase", + "description": "Passphrase\n\npassphrase of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.cname", + "description": "CNAME\n\ncname of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.arecord", + "description": "DNS A Record\n\nEntry for DNS A Record", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.displayName", + "description": "Display Name\n\nDisplay Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.health", + "description": "Health\n\nHealth", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EDGE_IGNORE", + "EDGE_HEALTHY", + "EDGE_UNHEALTHY", + "EDGE_DISCONNECTED" + ], + "default": "EDGE_IGNORE" + }, + { + "name": "spec.clusterData.manufacturer", + "description": "Manufacturer\n\nManufacturer", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterBlueprint", + "description": "ClusterBlueprint\n\nCluster Blueprint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.token", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.publishedBlueprint", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.systemTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.customTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.auxiliaryTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ClusterService" + ] + }, + "delete": { + "operationId": "ClusterService_DeleteCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3DeleteClusterResponse" + } + }, + "204": { + "description": "Returned when project is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.project", + "description": "Project of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Cluster" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.clusterType", + "description": "Cluster Type\n\nType of the cluster being created", + "in": "query", + "required": false, + "type": "string", + "default": "Imported" + }, + { + "name": "spec.metro.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.overrideSelector", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.environmentProvider", + "description": "EnvironmentProvider\n\nenvironment provider of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.kubernetesProvider", + "description": "KubernetesProvider\n\nkubernetes provider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionEnvironment", + "description": "ProvisionEnvironment\n\nprovision environment", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionPackageType", + "description": "ProvisionPackageType\n\nprovision package type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionType", + "description": "ProvisionType\n\nprovision type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.state", + "description": "State\n\nstate", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.shareMode", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ClusterShareModeNotSet", + "ALL", + "CUSTOM" + ], + "default": "ClusterShareModeNotSet" + }, + { + "name": "spec.proxyConfig.httpProxy", + "description": "HttpProxy\n\nhttp proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.httpsProxy", + "description": "HttpsProxy\n\nhttps proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.noProxy", + "description": "noproxy\n\nnoproxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.proxyAuth", + "description": "ProxyAuth\n\nproxy auth", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.allowInsecureBootstrap", + "description": "AllowInsecureBootstrap\n\nAllow insecure bootstrap", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.enabled", + "description": "Enabled\n\nenabled", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.bootstrapCA", + "description": "BootstrapCA\n\nCertificate Authority of bootstrap server", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.provider", + "description": "Provider\n\nProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.passphrase", + "description": "Passphrase\n\npassphrase of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.cname", + "description": "CNAME\n\ncname of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.arecord", + "description": "DNS A Record\n\nEntry for DNS A Record", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.displayName", + "description": "Display Name\n\nDisplay Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.health", + "description": "Health\n\nHealth", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EDGE_IGNORE", + "EDGE_HEALTHY", + "EDGE_UNHEALTHY", + "EDGE_DISCONNECTED" + ], + "default": "EDGE_IGNORE" + }, + { + "name": "spec.clusterData.manufacturer", + "description": "Manufacturer\n\nManufacturer", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterBlueprint", + "description": "ClusterBlueprint\n\nCluster Blueprint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.token", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.publishedBlueprint", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.systemTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.customTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.auxiliaryTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ClusterService" + ] + }, + "put": { + "operationId": "ClusterService_UpdateCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Cluster" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.project", + "description": "Project of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Cluster", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ClusterSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Cluster", + "title": "Cluster", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + } + } + ], + "tags": [ + "ClusterService" + ] + } + }, + "/infra/v3/project/{metadata.project}/cluster/{metadata.name}/download": { + "get": { + "operationId": "ClusterService_DownloadCluster", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.project", + "description": "Project of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Cluster" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.clusterType", + "description": "Cluster Type\n\nType of the cluster being created", + "in": "query", + "required": false, + "type": "string", + "default": "Imported" + }, + { + "name": "spec.metro.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metro.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.overrideSelector", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.environmentProvider", + "description": "EnvironmentProvider\n\nenvironment provider of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.kubernetesProvider", + "description": "KubernetesProvider\n\nkubernetes provider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionEnvironment", + "description": "ProvisionEnvironment\n\nprovision environment", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionPackageType", + "description": "ProvisionPackageType\n\nprovision package type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.provisionType", + "description": "ProvisionType\n\nprovision type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.params.state", + "description": "State\n\nstate", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.shareMode", + "description": "Override Selector\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ClusterShareModeNotSet", + "ALL", + "CUSTOM" + ], + "default": "ClusterShareModeNotSet" + }, + { + "name": "spec.proxyConfig.httpProxy", + "description": "HttpProxy\n\nhttp proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.httpsProxy", + "description": "HttpsProxy\n\nhttps proxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.noProxy", + "description": "noproxy\n\nnoproxy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.proxyAuth", + "description": "ProxyAuth\n\nproxy auth", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.proxyConfig.allowInsecureBootstrap", + "description": "AllowInsecureBootstrap\n\nAllow insecure bootstrap", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.enabled", + "description": "Enabled\n\nenabled", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.proxyConfig.bootstrapCA", + "description": "BootstrapCA\n\nCertificate Authority of bootstrap server", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.provider", + "description": "Provider\n\nProvider", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.passphrase", + "description": "Passphrase\n\npassphrase of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.cname", + "description": "CNAME\n\ncname of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.arecord", + "description": "DNS A Record\n\nEntry for DNS A Record", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.displayName", + "description": "Display Name\n\nDisplay Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.health", + "description": "Health\n\nHealth", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "EDGE_IGNORE", + "EDGE_HEALTHY", + "EDGE_UNHEALTHY", + "EDGE_DISCONNECTED" + ], + "default": "EDGE_IGNORE" + }, + { + "name": "spec.clusterData.manufacturer", + "description": "Manufacturer\n\nManufacturer", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterBlueprint", + "description": "ClusterBlueprint\n\nCluster Blueprint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.token", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.publishedBlueprint", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clusterData.clusterStatus.systemTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.customTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "spec.clusterData.clusterStatus.auxiliaryTaskCount", + "description": "Cluster Information\n\nOverride selector of the cluster", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ClusterService" + ] + } + }, + "/infra/v3/project/{project}/cluster": { + "get": { + "operationId": "ClusterService_GetClusters", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3ClusterList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "project", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ClusterService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v1NodeCondition": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of node condition." + }, + "status": { + "type": "string", + "description": "Status of the condition, one of True, False, Unknown." + }, + "lastHeartbeatTime": { + "$ref": "#/definitions/v1Time", + "title": "Last time we got an update on a given condition.\n+optional" + }, + "lastTransitionTime": { + "$ref": "#/definitions/v1Time", + "title": "Last time the condition transit from one status to another.\n+optional" + }, + "reason": { + "type": "string", + "title": "(brief) reason for the condition's last transition.\n+optional" + }, + "message": { + "type": "string", + "title": "Human readable message indicating details about last transition.\n+optional" + } + }, + "description": "NodeCondition contains condition information for a node." + }, + "v1NodeSystemInfo": { + "type": "object", + "properties": { + "machineID": { + "type": "string", + "title": "MachineID reported by the node. For unique machine identification\nin the cluster this field is preferred. Learn more from man(5)\nmachine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html" + }, + "systemUUID": { + "type": "string", + "title": "SystemUUID reported by the node. For unique machine identification\nMachineID is preferred. This field is specific to Red Hat hosts\nhttps://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid" + }, + "bootID": { + "type": "string", + "description": "Boot ID reported by the node." + }, + "kernelVersion": { + "type": "string", + "description": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64)." + }, + "osImage": { + "type": "string", + "description": "OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy))." + }, + "containerRuntimeVersion": { + "type": "string", + "description": "ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0)." + }, + "kubeletVersion": { + "type": "string", + "description": "Kubelet Version reported by the node." + }, + "kubeProxyVersion": { + "type": "string", + "description": "KubeProxy Version reported by the node." + }, + "operatingSystem": { + "type": "string", + "title": "The Operating System reported by the node" + }, + "architecture": { + "type": "string", + "title": "The Architecture reported by the node" + } + }, + "description": "NodeSystemInfo is a set of ids/uuids to uniquely identify the node." + }, + "v1Taint": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Required. The taint key to be applied to a node." + }, + "value": { + "type": "string", + "title": "The taint value corresponding to the taint key.\n+optional" + }, + "effect": { + "type": "string", + "description": "Required. The effect of the taint on pods\nthat do not tolerate the taint.\nValid effects are NoSchedule, PreferNoSchedule and NoExecute." + }, + "timeAdded": { + "$ref": "#/definitions/v1Time", + "title": "TimeAdded represents the time at which the taint was added.\nIt is only written for NoExecute taints.\n+optional" + } + }, + "description": "The node this Taint is attached to has the \"effect\" on\nany pod that does not tolerate the Taint." + }, + "v1Time": { + "type": "object", + "properties": { + "seconds": { + "type": "string", + "format": "int64", + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive." + }, + "nanos": { + "type": "integer", + "format": "int32", + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context." + } + }, + "description": "Time is a wrapper around time.Time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false" + }, + "v3Cluster": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Cluster", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ClusterSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Cluster", + "title": "Cluster", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3ClusterCondition": { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/v3ClusterConditionType", + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "status": { + "$ref": "#/definitions/v3ParalusConditionStatus", + "description": "Current status of the cluster", + "title": "Cluster Condition Status" + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Cluster condition last updated", + "title": "Cluster condition last updated" + }, + "reason": { + "type": "string", + "description": "Reason of cluster condition", + "title": "Reason of cluster condition" + } + } + }, + "v3ClusterConditionType": { + "type": "string", + "enum": [ + "ClusterBlueprintSync", + "ClusterApprove", + "ClusterCheckIn", + "ClusterNodeSync", + "ClusterRegister", + "ClusterNamespaceSync", + "ClusterReady", + "ClusterAuxiliaryTaskSync", + "ClusterBootstrapAgent", + "ClusterDelete" + ], + "default": "ClusterBlueprintSync" + }, + "v3ClusterData": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Provider", + "title": "Provider", + "readOnly": true + }, + "passphrase": { + "type": "string", + "description": "passphrase of the cluster", + "title": "Passphrase", + "readOnly": true + }, + "cname": { + "type": "string", + "description": "cname of the cluster", + "title": "CNAME", + "readOnly": true + }, + "arecord": { + "type": "string", + "description": "Entry for DNS A Record", + "title": "DNS A Record", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name", + "title": "Display Name", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/v3Health", + "description": "Health", + "title": "Health", + "readOnly": true + }, + "manufacturer": { + "type": "string", + "description": "Manufacturer", + "title": "Manufacturer", + "readOnly": true + }, + "clusterBlueprint": { + "type": "string", + "description": "Cluster Blueprint", + "title": "ClusterBlueprint", + "readOnly": true + }, + "nodes": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ClusterNode" + }, + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "projects": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ProjectCluster" + }, + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "clusterStatus": { + "$ref": "#/definitions/v3ClusterStatus", + "description": "Cluster Status", + "title": "ClusterStatus", + "readOnly": true + } + } + }, + "v3ClusterList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "ClusterList", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Cluster", + "readOnly": true + }, + "description": "List of the resources", + "title": "Items" + } + } + }, + "v3ClusterNode": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/v3Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ClusterNodeSpec" + }, + "status": { + "$ref": "#/definitions/v3ClusterNodeStatus" + } + } + }, + "v3ClusterNodeIP": { + "type": "object", + "properties": { + "privateIP": { + "type": "string" + }, + "publicIP": { + "type": "string" + } + } + }, + "v3ClusterNodeSpec": { + "type": "object", + "properties": { + "unschedulable": { + "type": "boolean" + }, + "taints": { + "type": "array", + "items": { + "$ref": "#/definitions/v1Taint" + } + } + } + }, + "v3ClusterNodeState": { + "type": "string", + "enum": [ + "ClusterNodeCreated", + "ClusterNodeNotReady", + "ClusterNodeReady" + ], + "default": "ClusterNodeCreated" + }, + "v3ClusterNodeStatus": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/v3ClusterNodeState" + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/v1NodeCondition" + } + }, + "nodeInfo": { + "$ref": "#/definitions/v1NodeSystemInfo" + }, + "capacity": { + "$ref": "#/definitions/v3Resources" + }, + "allocatable": { + "$ref": "#/definitions/v3Resources" + }, + "allocated": { + "$ref": "#/definitions/v3Resources" + }, + "ips": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ClusterNodeIP" + } + } + } + }, + "v3ClusterShareMode": { + "type": "string", + "enum": [ + "ClusterShareModeNotSet", + "ALL", + "CUSTOM" + ], + "default": "ClusterShareModeNotSet" + }, + "v3ClusterSpec": { + "type": "object", + "properties": { + "clusterType": { + "type": "string", + "default": "Imported", + "description": "Type of the cluster being created", + "title": "Cluster Type" + }, + "metro": { + "$ref": "#/definitions/v3Metro", + "description": "Location of the cluster", + "title": "Location" + }, + "overrideSelector": { + "type": "string", + "description": "Override selector of the cluster", + "title": "Override Selector" + }, + "params": { + "$ref": "#/definitions/v3ProvisionParams", + "description": "Cluster provisioning params", + "title": "Provision Params" + }, + "shareMode": { + "$ref": "#/definitions/v3ClusterShareMode", + "description": "Override selector of the cluster", + "title": "Override Selector" + }, + "proxyConfig": { + "$ref": "#/definitions/v3ProxyConfig", + "description": "Override selector of the cluster", + "title": "ProxyConfig" + }, + "clusterData": { + "$ref": "#/definitions/v3ClusterData", + "description": "Override selector of the cluster", + "title": "Cluster Information", + "readOnly": true + } + } + }, + "v3ClusterStatus": { + "type": "object", + "properties": { + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ClusterCondition" + }, + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "token": { + "type": "string", + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "publishedBlueprint": { + "type": "string", + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "systemTaskCount": { + "type": "string", + "format": "int64", + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "customTaskCount": { + "type": "string", + "format": "int64", + "description": "Override selector of the cluster", + "title": "Cluster Information" + }, + "auxiliaryTaskCount": { + "type": "string", + "format": "int64", + "description": "Override selector of the cluster", + "title": "Cluster Information" + } + } + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3DeleteClusterResponse": { + "type": "object" + }, + "v3Health": { + "type": "string", + "enum": [ + "EDGE_IGNORE", + "EDGE_HEALTHY", + "EDGE_UNHEALTHY", + "EDGE_DISCONNECTED" + ], + "default": "EDGE_IGNORE" + }, + "v3HttpBody": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "The HTTP Content-Type header value specifying the content type of the body." + }, + "data": { + "type": "string", + "format": "byte", + "description": "The HTTP request/response body as raw binary." + } + }, + "title": "HttpBody represents arbitrary HTTP Body. It should only be used for\npayload formats that can't be represented as JSON" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Metro": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID Location of the cluster", + "title": "ID of Location" + }, + "name": { + "type": "string", + "description": "Location of the cluster", + "title": "Location" + }, + "city": { + "type": "string", + "description": "City of the location", + "title": "City", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of the location", + "title": "State", + "readOnly": true + }, + "country": { + "type": "string", + "description": "country of the location", + "title": "Country", + "readOnly": true + }, + "locale": { + "type": "string", + "description": "locale of the location", + "title": "Locale", + "readOnly": true + }, + "latitude": { + "type": "string", + "description": "Latitude of the location", + "title": "Latitude", + "readOnly": true + }, + "longitude": { + "type": "string", + "description": "Longitude of the location", + "title": "Longitude", + "readOnly": true + }, + "countryCode": { + "type": "string", + "description": "CountryCode of the location", + "title": "CountryCode", + "readOnly": true + }, + "stateCode": { + "type": "string", + "description": "StateCode of the location", + "title": "StateCode", + "readOnly": true + } + } + }, + "v3ParalusConditionStatus": { + "type": "string", + "enum": [ + "NotSet", + "Pending", + "InProgress", + "Success", + "Failed", + "Retry", + "Skipped", + "Stopped", + "Expired", + "Stopping", + "Submitted" + ], + "default": "NotSet", + "title": "ParalusConditionStatus is the status of the status condition" + }, + "v3ProjectCluster": { + "type": "object", + "properties": { + "projectID": { + "type": "string", + "description": "Project ID associated with the cluster", + "title": "Project ID" + }, + "clusterID": { + "type": "string", + "description": "Cluster ID associated with the project", + "title": "Cluster ID" + } + } + }, + "v3ProvisionParams": { + "type": "object", + "properties": { + "environmentProvider": { + "type": "string", + "description": "environment provider of the cluster", + "title": "EnvironmentProvider" + }, + "kubernetesProvider": { + "type": "string", + "description": "kubernetes provider", + "title": "KubernetesProvider" + }, + "provisionEnvironment": { + "type": "string", + "description": "provision environment", + "title": "ProvisionEnvironment" + }, + "provisionPackageType": { + "type": "string", + "description": "provision package type", + "title": "ProvisionPackageType" + }, + "provisionType": { + "type": "string", + "description": "provision type", + "title": "ProvisionType" + }, + "state": { + "type": "string", + "description": "state", + "title": "State" + } + } + }, + "v3ProxyConfig": { + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "http proxy", + "title": "HttpProxy" + }, + "httpsProxy": { + "type": "string", + "description": "https proxy", + "title": "HttpsProxy" + }, + "noProxy": { + "type": "string", + "description": "noproxy", + "title": "noproxy" + }, + "proxyAuth": { + "type": "string", + "description": "proxy auth", + "title": "ProxyAuth" + }, + "allowInsecureBootstrap": { + "type": "boolean", + "description": "Allow insecure bootstrap", + "title": "AllowInsecureBootstrap" + }, + "enabled": { + "type": "boolean", + "description": "enabled", + "title": "Enabled" + }, + "bootstrapCA": { + "type": "string", + "description": "Certificate Authority of bootstrap server", + "title": "BootstrapCA" + } + } + }, + "v3Resources": { + "type": "object", + "properties": { + "cpuCount": { + "type": "string", + "format": "int64" + }, + "ephemeralStorageKB": { + "type": "string", + "format": "int64" + }, + "memoryKB": { + "type": "string", + "format": "int64" + }, + "podsCount": { + "type": "string", + "format": "int64" + }, + "gpuCount": { + "type": "string", + "format": "int64" + } + } + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/cluster_authz.swagger.json b/apis/cluster_authz.swagger.json new file mode 100644 index 0000000..be393d6 --- /dev/null +++ b/apis/cluster_authz.swagger.json @@ -0,0 +1,399 @@ +{ + "swagger": "2.0", + "info": { + "title": "Sentry Cluster Authorization Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "ClusterAuthorizationService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/v2/sentry/authorization/user": { + "get": { + "operationId": "ClusterAuthorizationService_GetUserAuthorization", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcGetUserAuthorizationResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "userCN", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "certIssueSeconds", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + } + ], + "tags": [ + "ClusterAuthorizationService" + ] + } + } + }, + "definitions": { + "controllerStepObject": { + "type": "object", + "properties": { + "typeMeta": { + "$ref": "#/definitions/metav1TypeMeta" + }, + "objectMeta": { + "$ref": "#/definitions/v1ObjectMeta" + }, + "name": { + "type": "string" + }, + "raw": { + "type": "string", + "format": "byte" + } + }, + "title": "+kubebuilder:object:generate=true\nStepObject can represent any kubernetes object" + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "metav1TypeMeta": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "title": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional" + }, + "apiVersion": { + "type": "string", + "title": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional" + } + }, + "description": "TypeMeta describes an individual object in an API response or request\nwith strings representing the type of the object and its API schema version.\nStructures that are versioned or persisted should inline TypeMeta.\n\n+k8s:deepcopy-gen=false" + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcGetUserAuthorizationResponse": { + "type": "object", + "properties": { + "userName": { + "type": "string" + }, + "serviceAccount": { + "$ref": "#/definitions/controllerStepObject" + }, + "clusterRoles": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "clusterRoleBindings": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "roleBindings": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "deleteClusterRoleBindings": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "deleteRoleBindings": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "namespaces": { + "type": "array", + "items": { + "$ref": "#/definitions/controllerStepObject" + } + }, + "roleName": { + "type": "string" + }, + "isRead": { + "type": "boolean" + }, + "enforceOrgAdminOnlySecretAccess": { + "type": "boolean" + }, + "isOrgAdmin": { + "type": "boolean" + } + } + }, + "v1FieldsV1": { + "type": "object", + "properties": { + "Raw": { + "type": "string", + "format": "byte", + "description": "Raw is the underlying serialization of this object." + } + }, + "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set,\nor a string representing a sub-field or item. The string will follow one of these four formats:\n'f:\u003cname\u003e', where \u003cname\u003e is the name of a field in a struct, or key in a map\n'v:\u003cvalue\u003e', where \u003cvalue\u003e is the exact json formatted value of a list item\n'i:\u003cindex\u003e', where \u003cindex\u003e is position of a item in a list\n'k:\u003ckeys\u003e', where \u003ckeys\u003e is a map of a list item's key fields to their unique values\nIf a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff\n+protobuf.options.(gogoproto.goproto_stringer)=false" + }, + "v1ManagedFieldsEntry": { + "type": "object", + "properties": { + "manager": { + "type": "string", + "description": "Manager is an identifier of the workflow managing these fields." + }, + "operation": { + "type": "string", + "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'." + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted." + }, + "time": { + "$ref": "#/definitions/v1Time", + "title": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'\n+optional" + }, + "fieldsType": { + "type": "string", + "title": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"" + }, + "fieldsV1": { + "$ref": "#/definitions/v1FieldsV1", + "title": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.\n+optional" + } + }, + "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource\nthat the fieldset applies to." + }, + "v1ObjectMeta": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names\n+optional" + }, + "generateName": { + "type": "string", + "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will\nNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\nServerTimeout indicating a unique name could not be found in the time allotted, and the client\nshould retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional" + }, + "namespace": { + "type": "string", + "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/namespaces\n+optional" + }, + "selfLink": { + "type": "string", + "description": "SelfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n\nDEPRECATED\nKubernetes will stop propagating this field in 1.20 release and the field is planned\nto be removed in 1.21 release.\n+optional" + }, + "uid": { + "type": "string", + "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids\n+optional" + }, + "resourceVersion": { + "type": "string", + "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "generation": { + "type": "string", + "format": "int64", + "title": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional" + }, + "creationTimestamp": { + "$ref": "#/definitions/v1Time", + "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionTimestamp": { + "$ref": "#/definitions/v1Time", + "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional" + }, + "deletionGracePeriodSeconds": { + "type": "string", + "format": "int64", + "title": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels\n+optional" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations\n+optional" + }, + "ownerReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/v1OwnerReference" + }, + "title": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge" + }, + "finalizers": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge" + }, + "clusterName": { + "type": "string", + "title": "The name of the cluster which the object belongs to.\nThis is used to distinguish resources with same name and namespace in different clusters.\nThis field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.\n+optional" + }, + "managedFields": { + "type": "array", + "items": { + "$ref": "#/definitions/v1ManagedFieldsEntry" + }, + "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional" + } + }, + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects\nusers must create." + }, + "v1OwnerReference": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "description": "API version of the referent." + }, + "kind": { + "type": "string", + "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + }, + "name": { + "type": "string", + "title": "Name of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + }, + "uid": { + "type": "string", + "title": "UID of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids" + }, + "controller": { + "type": "boolean", + "title": "If true, this reference points to the managing controller.\n+optional" + }, + "blockOwnerDeletion": { + "type": "boolean", + "title": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional" + } + }, + "description": "OwnerReference contains enough information to let you identify an owning\nobject. An owning object must be in the same namespace as the dependent, or\nbe cluster-scoped, so there is no namespace field." + }, + "v1Time": { + "type": "object", + "properties": { + "seconds": { + "type": "string", + "format": "int64", + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive." + }, + "nanos": { + "type": "integer", + "format": "int32", + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context." + } + }, + "description": "Time is a wrapper around time.Time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/cluster_controller.swagger.json b/apis/cluster_controller.swagger.json new file mode 100644 index 0000000..e565ac0 --- /dev/null +++ b/apis/cluster_controller.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/controller/cluster_controller.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/common.swagger.json b/apis/common.swagger.json new file mode 100644 index 0000000..26d0a30 --- /dev/null +++ b/apis/common.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/commonpb/v3/common.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/group.swagger.json b/apis/group.swagger.json new file mode 100644 index 0000000..d98eba4 --- /dev/null +++ b/apis/group.swagger.json @@ -0,0 +1,1234 @@ +{ + "swagger": "2.0", + "info": { + "title": "Group management Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "GroupService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/group/{metadata.name}": { + "get": { + "operationId": "GroupService_GetGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Group" + } + }, + "403": { + "description": "Returned when the group does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the group resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the group resource", + "in": "query", + "required": true, + "type": "string", + "default": "Group" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.users", + "description": "Users\n\nList of users for group", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.type", + "description": "Type\n\nType of group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "GroupService" + ] + }, + "delete": { + "operationId": "GroupService_DeleteGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Group" + } + }, + "204": { + "description": "Returned when group is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the group does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the group resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the group resource", + "in": "query", + "required": true, + "type": "string", + "default": "Group" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.users", + "description": "Users\n\nList of users for group", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.type", + "description": "Type\n\nType of group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "GroupService" + ] + }, + "put": { + "operationId": "GroupService_UpdateGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Group" + } + }, + "403": { + "description": "Returned when the group does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the group resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Group", + "description": "Kind of the group resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3GroupSpec", + "description": "Metadata of the group resource", + "title": "Metadata" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Group", + "title": "Group", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "GroupService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/groups": { + "post": { + "operationId": "GroupService_CreateGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Group" + } + }, + "201": { + "description": "Returned when group is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the group does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the group resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Group", + "description": "Kind of the group resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3GroupSpec", + "description": "Metadata of the group resource", + "title": "Metadata" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Group", + "title": "Group", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name", + "project" + ] + } + } + ], + "tags": [ + "GroupService" + ] + } + }, + "/auth/v3/partner/{partner}/organization/{organization}/groups": { + "get": { + "operationId": "GroupService_GetGroups", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3GroupList" + } + }, + "403": { + "description": "Returned when the group does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "partner", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "organization", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "GroupService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3Group": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the group resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Group", + "description": "Kind of the group resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the group resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3GroupSpec", + "description": "Metadata of the group resource", + "title": "Metadata" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Group", + "title": "Group", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3GroupList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "description": "API Version of the group list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Kind of the group list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the group list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Group", + "readOnly": true + }, + "description": "List of the group resources", + "title": "Items" + } + }, + "description": "Group list", + "title": "GroupList", + "readOnly": true + }, + "v3GroupSpec": { + "type": "object", + "properties": { + "projectNamespaceRoles": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ProjectNamespaceRole" + }, + "description": "Project, namespace, role associations for group", + "title": "ProjectNamespaceRoles" + }, + "users": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of users for group", + "title": "Users" + }, + "type": { + "type": "string", + "description": "Type of group", + "title": "Type" + } + }, + "description": "Group specification", + "title": "Group Specification" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3ProjectNamespaceRole": { + "type": "object", + "properties": { + "project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "namespace": { + "type": "string", + "description": "Namespace", + "title": "Namespace" + }, + "role": { + "type": "string", + "description": "Role", + "title": "Role" + }, + "group": { + "type": "string", + "description": "Group", + "title": "Group" + } + }, + "description": "Project, role and namespace pairing for permission", + "title": "ProjectNamespaceRole" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/group_permission.swagger.json b/apis/group_permission.swagger.json new file mode 100644 index 0000000..6b86dbc --- /dev/null +++ b/apis/group_permission.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/sentry/group_permission.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/idp.swagger.json b/apis/idp.swagger.json new file mode 100644 index 0000000..5df5295 --- /dev/null +++ b/apis/idp.swagger.json @@ -0,0 +1,1042 @@ +{ + "swagger": "2.0", + "info": { + "title": "Identity Provider (IdP) Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "IdpService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/sso/idp": { + "get": { + "operationId": "IdpService_ListIdps", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3IdpList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "tags": [ + "IdpService" + ] + }, + "post": { + "operationId": "IdpService_CreateIdp", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Idp" + } + }, + "201": { + "description": "Returned when idp is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "description": "Idp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v3Idp" + } + } + ], + "tags": [ + "IdpService" + ] + } + }, + "/auth/v3/sso/idp/{metadata.name}": { + "get": { + "operationId": "IdpService_GetIdp", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Idp" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the idp resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the idp resource", + "in": "query", + "required": true, + "type": "string", + "default": "Idp" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.idpName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.domain", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.acsUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.ssoUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.idpCert", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.spCert", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metadataUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metadataFilename", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.saeEnabled", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.groupAttributeName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.nameIdFormat", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.consumerBinding", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.spEntityId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "IdpService" + ] + }, + "delete": { + "operationId": "IdpService_DeleteIdp", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": {} + } + }, + "204": { + "description": "Returned when idp is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the idp resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the idp resource", + "in": "query", + "required": true, + "type": "string", + "default": "Idp" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.idpName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.domain", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.acsUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.ssoUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.idpCert", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.spCert", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metadataUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.metadataFilename", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.saeEnabled", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.groupAttributeName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.nameIdFormat", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.consumerBinding", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.spEntityId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "IdpService" + ] + }, + "put": { + "operationId": "IdpService_UpdateIdp", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Idp" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the idp resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Idp", + "description": "Kind of the idp resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3IdpSpec", + "description": "Spec of the idp resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Idp", + "title": "Idp", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "IdpService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3Idp": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the idp resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Idp", + "description": "Kind of the idp resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the idp resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3IdpSpec", + "description": "Spec of the idp resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Idp", + "title": "Idp", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3IdpList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the idp list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "IdpList", + "description": "Kind of the idp list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the idp list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Idp", + "readOnly": true + }, + "description": "List of the idp resources", + "title": "Items" + } + }, + "description": "idp list", + "title": "IdpList", + "readOnly": true + }, + "v3IdpSpec": { + "type": "object", + "properties": { + "idpName": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "acsUrl": { + "type": "string" + }, + "ssoUrl": { + "type": "string" + }, + "idpCert": { + "type": "string" + }, + "spCert": { + "type": "string" + }, + "metadataUrl": { + "type": "string" + }, + "metadataFilename": { + "type": "string" + }, + "saeEnabled": { + "type": "boolean" + }, + "groupAttributeName": { + "type": "string" + }, + "nameIdFormat": { + "type": "string" + }, + "consumerBinding": { + "type": "string" + }, + "spEntityId": { + "type": "string" + } + } + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/kubeconfig.swagger.json b/apis/kubeconfig.swagger.json new file mode 100644 index 0000000..41acc35 --- /dev/null +++ b/apis/kubeconfig.swagger.json @@ -0,0 +1,2572 @@ +{ + "swagger": "2.0", + "info": { + "title": "Sentry KubeConfig Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "KubeConfigService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/v2/sentry/kubeconfig/clustersystemsession": { + "get": { + "operationId": "KubeConfigService_GetForClusterSystemSession", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "systemUser", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/clusterwebsession": { + "get": { + "operationId": "KubeConfigService_GetForClusterWebSession", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "systemUser", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/revoke": { + "post": { + "operationId": "KubeConfigService_RevokeKubeconfig", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcRevokeKubeconfigResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/rpcRevokeKubeconfigRequest" + } + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/user": { + "get": { + "operationId": "KubeConfigService_GetForUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "namespace", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/{opts.urlScope_1}/setting": { + "get": { + "operationId": "KubeConfigService_GetUserSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcGetKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope_1", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "user/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubeConfigService" + ] + }, + "put": { + "operationId": "KubeConfigService_UpdateUserSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcUpdateKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope_1", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "user/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "opts": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + }, + "validitySeconds": { + "type": "string", + "format": "int64" + }, + "enableSessionCheck": { + "type": "boolean" + }, + "enablePrivateRelay": { + "type": "boolean" + }, + "enforceOrgAdminSecretAccess": { + "type": "boolean" + }, + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + } + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/{opts.urlScope_2}/setting": { + "get": { + "operationId": "KubeConfigService_GetSSOUserSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcGetKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope_2", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "ssouser/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubeConfigService" + ] + }, + "put": { + "operationId": "KubeConfigService_UpdateSSOUserSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcUpdateKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope_2", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "ssouser/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "opts": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + }, + "validitySeconds": { + "type": "string", + "format": "int64" + }, + "enableSessionCheck": { + "type": "boolean" + }, + "enablePrivateRelay": { + "type": "boolean" + }, + "enforceOrgAdminSecretAccess": { + "type": "boolean" + }, + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + } + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/{opts.urlScope}/download": { + "get": { + "operationId": "KubeConfigService_GetForUser2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "user/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "namespace", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/{opts.urlScope}/revoke": { + "post": { + "operationId": "KubeConfigService_RevokeKubeconfig2", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcRevokeKubeconfigResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "user/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "opts": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + } + } + } + } + ], + "tags": [ + "KubeConfigService" + ] + } + }, + "/v2/sentry/kubeconfig/{opts.urlScope}/setting": { + "get": { + "operationId": "KubeConfigService_GetOrganizationSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcGetKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "organization/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubeConfigService" + ] + }, + "put": { + "operationId": "KubeConfigService_UpdateOrganizationSetting", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcUpdateKubeconfigSettingResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "organization/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "opts": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + }, + "validitySeconds": { + "type": "string", + "format": "int64" + }, + "enableSessionCheck": { + "type": "boolean" + }, + "enablePrivateRelay": { + "type": "boolean" + }, + "enforceOrgAdminSecretAccess": { + "type": "boolean" + }, + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + } + } + ], + "tags": [ + "KubeConfigService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcGetKubeconfigSettingResponse": { + "type": "object", + "properties": { + "validitySeconds": { + "type": "string", + "format": "int64" + }, + "enableSessionCheck": { + "type": "boolean" + }, + "enablePrivateRelay": { + "type": "boolean" + }, + "enforceOrgAdminSecretAccess": { + "type": "boolean" + }, + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + }, + "rpcRevokeKubeconfigRequest": { + "type": "object", + "properties": { + "opts": { + "$ref": "#/definitions/v3QueryOptions" + } + } + }, + "rpcRevokeKubeconfigResponse": { + "type": "object" + }, + "rpcUpdateKubeconfigSettingResponse": { + "type": "object" + }, + "v3HttpBody": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "The HTTP Content-Type header value specifying the content type of the body." + }, + "data": { + "type": "string", + "format": "byte", + "description": "The HTTP request/response body as raw binary." + } + }, + "title": "HttpBody represents arbitrary HTTP Body. It should only be used for\npayload formats that can't be represented as JSON" + }, + "v3QueryOptions": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "urlScope": { + "type": "string", + "title": "urlScope is supposed to be passed in the URL as kind/HashID(value)" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/kubeconfig_setting.swagger.json b/apis/kubeconfig_setting.swagger.json new file mode 100644 index 0000000..f594b79 --- /dev/null +++ b/apis/kubeconfig_setting.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/sentry/kubeconfig_setting.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/kubectl_cluster.swagger.json b/apis/kubectl_cluster.swagger.json new file mode 100644 index 0000000..76b8a25 --- /dev/null +++ b/apis/kubectl_cluster.swagger.json @@ -0,0 +1,595 @@ +{ + "swagger": "2.0", + "info": { + "title": "Sentry KubectlClusterSettings Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "KubectlClusterSettingsService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/v2/sentry/kubectl/{opts.urlScope}/settings": { + "get": { + "operationId": "KubectlClusterSettingsService_GetKubectlClusterSettings", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcGetKubectlClusterSettingsResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "cluster/[^/]+" + }, + { + "name": "opts.q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "opts.ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "opts.username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "opts.blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "opts.type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "KubectlClusterSettingsService" + ] + }, + "put": { + "operationId": "KubectlClusterSettingsService_UpdateKubectlClusterSettings", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/rpcUpdateKubectlClusterSettingsResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "opts.urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "path", + "required": true, + "type": "string", + "pattern": "cluster/[^/]+" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "opts": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + }, + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + } + } + ], + "tags": [ + "KubectlClusterSettingsService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcGetKubectlClusterSettingsResponse": { + "type": "object", + "properties": { + "disableWebKubectl": { + "type": "boolean" + }, + "disableCLIKubectl": { + "type": "boolean" + } + } + }, + "rpcUpdateKubectlClusterSettingsResponse": { + "type": "object" + }, + "v3QueryOptions": { + "type": "object", + "properties": { + "q": { + "type": "string", + "title": "query for filtering" + }, + "name": { + "type": "string", + "title": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)" + }, + "selector": { + "type": "string", + "title": "selector is used to filter the labels of a resource" + }, + "partner": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "project": { + "type": "string" + }, + "group": { + "type": "string" + }, + "role": { + "type": "string" + }, + "displayName": { + "type": "string", + "title": "displayName only used for update queries to set displayName (READONLY)" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "labels only used for update queries to set labels (READONLY)" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "annotations only used for update queries to set annotations (READONLY)" + }, + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + }, + "ignoreScopeDefault": { + "type": "boolean", + "title": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID" + }, + "globalScope": { + "type": "boolean", + "title": "globalScope sets partnerID,organizationID,projectID = 0" + }, + "orderBy": { + "type": "string" + }, + "order": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "extended": { + "type": "boolean" + }, + "urlScope": { + "type": "string", + "title": "urlScope is supposed to be passed in the URL as kind/HashID(value)" + }, + "isSSOUser": { + "type": "boolean" + }, + "username": { + "type": "string" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "blueprintRef": { + "type": "string" + }, + "publishedVersion": { + "type": "string" + }, + "clusterID": { + "type": "string" + }, + "ID": { + "type": "string" + }, + "account": { + "type": "string" + }, + "type": { + "type": "string", + "title": "generic way to specify a type of resource, mainly for use in users endpoint" + } + }, + "title": "QueryOptions is the options for performing queries on resources" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/kubectl_cluster_setting.swagger.json b/apis/kubectl_cluster_setting.swagger.json new file mode 100644 index 0000000..7651be8 --- /dev/null +++ b/apis/kubectl_cluster_setting.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/sentry/kubectl_cluster_setting.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/metro.swagger.json b/apis/metro.swagger.json new file mode 100644 index 0000000..6abd98c --- /dev/null +++ b/apis/metro.swagger.json @@ -0,0 +1,1352 @@ +{ + "swagger": "2.0", + "info": { + "title": "Location Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "LocationService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/infra/v3/partner/{metadata.partner}/location": { + "get": { + "operationId": "LocationService_GetLocations", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3LocationList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Location" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "LocationService" + ] + }, + "post": { + "operationId": "LocationService_CreateLocation", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/infrav3Location" + } + }, + "201": { + "description": "Returned when location is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Location", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3Metro", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Location", + "title": "Location", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name", + "project" + ] + } + } + ], + "tags": [ + "LocationService" + ] + } + }, + "/infra/v3/partner/{metadata.partner}/location/{metadata.name}": { + "get": { + "operationId": "LocationService_GetLocation", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/infrav3Location" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Location" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "LocationService" + ] + }, + "delete": { + "operationId": "LocationService_DeleteLocation", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/infrav3Location" + } + }, + "204": { + "description": "Returned when organization is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "infra.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Location" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.id", + "description": "ID of Location\n\nID Location of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.name", + "description": "Location\n\nLocation of the cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\ncountry of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.locale", + "description": "Locale\n\nlocale of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.latitude", + "description": "Latitude\n\nLatitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.longitude", + "description": "Longitude\n\nLongitude of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.countryCode", + "description": "CountryCode\n\nCountryCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.stateCode", + "description": "StateCode\n\nStateCode of the location", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "LocationService" + ] + }, + "put": { + "operationId": "LocationService_UpdateLocation", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/infrav3Location" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Location", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3Metro", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Location", + "title": "Location", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "LocationService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "infrav3Location": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Location", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3Metro", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Location", + "title": "Location", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3LocationList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "infra.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "LocationList", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Metro", + "readOnly": true + }, + "description": "List of the resources", + "title": "Items" + } + } + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Metro": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID Location of the cluster", + "title": "ID of Location" + }, + "name": { + "type": "string", + "description": "Location of the cluster", + "title": "Location" + }, + "city": { + "type": "string", + "description": "City of the location", + "title": "City", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of the location", + "title": "State", + "readOnly": true + }, + "country": { + "type": "string", + "description": "country of the location", + "title": "Country", + "readOnly": true + }, + "locale": { + "type": "string", + "description": "locale of the location", + "title": "Locale", + "readOnly": true + }, + "latitude": { + "type": "string", + "description": "Latitude of the location", + "title": "Latitude", + "readOnly": true + }, + "longitude": { + "type": "string", + "description": "Longitude of the location", + "title": "Longitude", + "readOnly": true + }, + "countryCode": { + "type": "string", + "description": "CountryCode of the location", + "title": "CountryCode", + "readOnly": true + }, + "stateCode": { + "type": "string", + "description": "StateCode of the location", + "title": "StateCode", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/namespace.swagger.json b/apis/namespace.swagger.json new file mode 100644 index 0000000..c7ba2d2 --- /dev/null +++ b/apis/namespace.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/scheduler/namespace.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/oidc_provider.swagger.json b/apis/oidc_provider.swagger.json new file mode 100644 index 0000000..21db807 --- /dev/null +++ b/apis/oidc_provider.swagger.json @@ -0,0 +1,1036 @@ +{ + "swagger": "2.0", + "info": { + "title": "OIdC Provider Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "OIDCProviderService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/sso/oidc/provider": { + "get": { + "operationId": "OIDCProviderService_ListOIDCProvider", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3OIDCProviderList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "tags": [ + "OIDCProviderService" + ] + }, + "post": { + "operationId": "OIDCProviderService_CreateOIDCProvider", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3OIDCProvider" + } + }, + "201": { + "description": "Returned when oidc provider is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "description": "Open Id Connect Provider", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v3OIDCProvider" + } + } + ], + "tags": [ + "OIDCProviderService" + ] + } + }, + "/auth/v3/sso/oidc/provider/{metadata.name}": { + "get": { + "operationId": "OIDCProviderService_GetOIDCProvider", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3OIDCProvider" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the OIDCProvider resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the OIDCProvider resource", + "in": "query", + "required": true, + "type": "string", + "default": "OIDCProvider" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.providerName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.mapperUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.mapperFilename", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clientId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clientSecret", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.scopes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.issuerUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.authUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.tokenUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.predefined", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.callbackUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "OIDCProviderService" + ] + }, + "delete": { + "operationId": "OIDCProviderService_DeleteOIDCProvider", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": {} + } + }, + "204": { + "description": "Returned when oidc provider is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the OIDCProvider resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the OIDCProvider resource", + "in": "query", + "required": true, + "type": "string", + "default": "OIDCProvider" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.providerName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.mapperUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.mapperFilename", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clientId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.clientSecret", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.scopes", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.issuerUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.authUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.tokenUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.predefined", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.callbackUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "OIDCProviderService" + ] + }, + "put": { + "operationId": "OIDCProviderService_UpdateOIDCProvider", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3OIDCProvider" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the OIDCProvider resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "OIDCProvider", + "description": "Kind of the OIDCProvider resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3OIDCProviderSpec", + "description": "Spec of the OIDCProvider resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Open Id Connect Provider", + "title": "OIDCProvider", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "OIDCProviderService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "protobufNullValue": { + "type": "string", + "enum": [ + "NULL_VALUE" + ], + "default": "NULL_VALUE", + "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3OIDCProvider": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the OIDCProvider resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "OIDCProvider", + "description": "Kind of the OIDCProvider resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the OIDCProvider resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3OIDCProviderSpec", + "description": "Spec of the OIDCProvider resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Open Id Connect Provider", + "title": "OIDCProvider", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3OIDCProviderList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the OIDCProvider list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "OIDCProviderList", + "description": "Kind of the OIDCProvider list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the OIDCProvider list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3OIDCProvider", + "readOnly": true + }, + "description": "List of the OIDCProvider resources", + "title": "Items" + } + }, + "description": "OIDC providers list", + "title": "OIDCProviderList", + "readOnly": true + }, + "v3OIDCProviderSpec": { + "type": "object", + "properties": { + "providerName": { + "type": "string" + }, + "mapperUrl": { + "type": "string" + }, + "mapperFilename": { + "type": "string" + }, + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "issuerUrl": { + "type": "string" + }, + "authUrl": { + "type": "string" + }, + "tokenUrl": { + "type": "string" + }, + "requestedClaims": { + "type": "object" + }, + "predefined": { + "type": "boolean" + }, + "callbackUrl": { + "type": "string" + } + }, + "description": "OIDCProvider specification", + "title": "OIDCProvider Specification" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/organization.swagger.json b/apis/organization.swagger.json new file mode 100644 index 0000000..b4decc6 --- /dev/null +++ b/apis/organization.swagger.json @@ -0,0 +1,1586 @@ +{ + "swagger": "2.0", + "info": { + "title": "Organization Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "OrganizationService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/partner/{metadata.partner}/organization": { + "post": { + "operationId": "OrganizationService_CreateOrganization", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Organization" + } + }, + "201": { + "description": "Returned when organization is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Organization", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3OrganizationSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Organization", + "title": "Organization", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name", + "project" + ] + } + } + ], + "tags": [ + "OrganizationService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organization/{metadata.name}": { + "get": { + "operationId": "OrganizationService_GetOrganization", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Organization" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Organization" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.billingAddress", + "description": "Billing Address\n\nBilling address of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.active", + "description": "Active\n\nRepresents if this organization is active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.approved", + "description": "Approved\n\nIs this organization active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.type", + "description": "Type\n\nType of organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine1", + "description": "Address Line 1\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine2", + "description": "Address Line 2\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\nCountry of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone\n\nPhone number of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.zipcode", + "description": "Zipcode\n\nZipcode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.isPrivate", + "description": "Is Private\n\nIs Private Organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.isTotpEnabled", + "description": "Is TOTP Enabled\n\nIs TOTP enabled at organization level", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.areClustersShared", + "description": "Clusters Shared\n\nAre clusters shared", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.enabled", + "description": "Enabled\n\nIs lockout settings enabled?", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.periodMin", + "description": "Period Minutes\n\nLockout period in Minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.lockout.attempts", + "description": "Attempts\n\nMax number of attempts before lockout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.idleLogoutMin", + "description": "Idle Logout Minutes\n\nIdle Logout time in minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "OrganizationService" + ] + }, + "delete": { + "operationId": "OrganizationService_DeleteOrganization", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Organization" + } + }, + "204": { + "description": "Returned when organization is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Organization" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.billingAddress", + "description": "Billing Address\n\nBilling address of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.active", + "description": "Active\n\nRepresents if this organization is active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.approved", + "description": "Approved\n\nIs this organization active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.type", + "description": "Type\n\nType of organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine1", + "description": "Address Line 1\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine2", + "description": "Address Line 2\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\nCountry of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone\n\nPhone number of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.zipcode", + "description": "Zipcode\n\nZipcode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.isPrivate", + "description": "Is Private\n\nIs Private Organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.isTotpEnabled", + "description": "Is TOTP Enabled\n\nIs TOTP enabled at organization level", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.areClustersShared", + "description": "Clusters Shared\n\nAre clusters shared", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.enabled", + "description": "Enabled\n\nIs lockout settings enabled?", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.periodMin", + "description": "Period Minutes\n\nLockout period in Minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.lockout.attempts", + "description": "Attempts\n\nMax number of attempts before lockout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.idleLogoutMin", + "description": "Idle Logout Minutes\n\nIdle Logout time in minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "OrganizationService" + ] + }, + "put": { + "operationId": "OrganizationService_UpdateOrganization", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Organization" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Organization", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3OrganizationSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Organization", + "title": "Organization", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "OrganizationService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organizations": { + "get": { + "operationId": "OrganizationService_GetOrganizations", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3OrganizationList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Organization" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.billingAddress", + "description": "Billing Address\n\nBilling address of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.active", + "description": "Active\n\nRepresents if this organization is active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.approved", + "description": "Approved\n\nIs this organization active", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.type", + "description": "Type\n\nType of organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine1", + "description": "Address Line 1\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.addressLine2", + "description": "Address Line 2\n\nAddress of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.city", + "description": "City\n\nCity", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.country", + "description": "Country\n\nCountry of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone\n\nPhone number of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.state", + "description": "State\n\nState of the organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.zipcode", + "description": "Zipcode\n\nZipcode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.isPrivate", + "description": "Is Private\n\nIs Private Organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.isTotpEnabled", + "description": "Is TOTP Enabled\n\nIs TOTP enabled at organization level", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.areClustersShared", + "description": "Clusters Shared\n\nAre clusters shared", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.enabled", + "description": "Enabled\n\nIs lockout settings enabled?", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.settings.lockout.periodMin", + "description": "Period Minutes\n\nLockout period in Minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.lockout.attempts", + "description": "Attempts\n\nMax number of attempts before lockout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "spec.settings.idleLogoutMin", + "description": "Idle Logout Minutes\n\nIdle Logout time in minutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "OrganizationService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Lockout": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is lockout settings enabled?", + "title": "Enabled" + }, + "periodMin": { + "type": "integer", + "format": "int32", + "description": "Lockout period in Minutes", + "title": "Period Minutes" + }, + "attempts": { + "type": "integer", + "format": "int32", + "description": "Max number of attempts before lockout", + "title": "Attempts" + } + } + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Organization": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Organization", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3OrganizationSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Organization", + "title": "Organization", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3OrganizationList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "OrganizationList", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Organization", + "readOnly": true + }, + "description": "List of the resources", + "title": "Items" + } + } + }, + "v3OrganizationSettings": { + "type": "object", + "properties": { + "lockout": { + "$ref": "#/definitions/v3Lockout", + "description": "Lockout settings of the organization", + "title": "Lockout" + }, + "idleLogoutMin": { + "type": "integer", + "format": "int32", + "description": "Idle Logout time in minutes", + "title": "Idle Logout Minutes" + } + } + }, + "v3OrganizationSpec": { + "type": "object", + "properties": { + "billingAddress": { + "type": "string", + "description": "Billing address of the organization", + "title": "Billing Address" + }, + "active": { + "type": "boolean", + "description": "Represents if this organization is active", + "title": "Active" + }, + "approved": { + "type": "boolean", + "description": "Is this organization active", + "title": "Approved" + }, + "type": { + "type": "string", + "description": "Type of organization", + "title": "Type" + }, + "addressLine1": { + "type": "string", + "description": "Address of the organization", + "title": "Address Line 1" + }, + "addressLine2": { + "type": "string", + "description": "Address of the organization", + "title": "Address Line 2" + }, + "city": { + "type": "string", + "description": "City", + "title": "City" + }, + "country": { + "type": "string", + "description": "Country of the organization", + "title": "Country" + }, + "phone": { + "type": "string", + "description": "Phone number of the organization", + "title": "Phone" + }, + "state": { + "type": "string", + "description": "State of the organization", + "title": "State" + }, + "zipcode": { + "type": "string", + "description": "Zipcode", + "title": "Zipcode" + }, + "isPrivate": { + "type": "boolean", + "description": "Is Private Organization", + "title": "Is Private" + }, + "isTotpEnabled": { + "type": "boolean", + "description": "Is TOTP enabled at organization level", + "title": "Is TOTP Enabled" + }, + "areClustersShared": { + "type": "boolean", + "description": "Are clusters shared", + "title": "Clusters Shared" + }, + "settings": { + "$ref": "#/definitions/v3OrganizationSettings", + "description": "Various settings like lockout, auto-logout configuration", + "title": "Settings" + } + } + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/partner.swagger.json b/apis/partner.swagger.json new file mode 100644 index 0000000..35ec4ad --- /dev/null +++ b/apis/partner.swagger.json @@ -0,0 +1,1019 @@ +{ + "swagger": "2.0", + "info": { + "title": "Partner Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "PartnerService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/partner": { + "get": { + "operationId": "PartnerService_GetInitPartner", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Partner" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "tags": [ + "PartnerService" + ] + }, + "post": { + "operationId": "PartnerService_CreatePartner", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Partner" + } + }, + "201": { + "description": "Returned when partner is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "description": "Partner", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v3Partner" + } + } + ], + "tags": [ + "PartnerService" + ] + } + }, + "/auth/v3/partner/{metadata.name}": { + "get": { + "operationId": "PartnerService_GetPartner", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Partner" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Partner" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.host", + "description": "Host\n\nHost of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.domain", + "description": "Domain\n\nDomain of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.tosLink", + "description": "TOS\n\nTerms of service url of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.logoLink", + "description": "Logo\n\nLogo url of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.notificationEmail", + "description": "Notification Email\n\nNotification email of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.helpdeskEmail", + "description": "Helpdesk Email\n\nHelpdesk email of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.productName", + "description": "Product Name\n\nProduct Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.supportTeamName", + "description": "Support Team Name\n\nSupport Team Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.opsHost", + "description": "OPS Host\n\nOperations host of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.favIconLink", + "description": "Fav Icon Link\n\nFav Icon Link", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.isTOTPEnabled", + "description": "TOTP Enabled\n\nTOTP Enabled flag at the partner level", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "PartnerService" + ] + }, + "delete": { + "operationId": "PartnerService_DeletePartner", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Partner" + } + }, + "204": { + "description": "Returned when partner is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Partner" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.host", + "description": "Host\n\nHost of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.domain", + "description": "Domain\n\nDomain of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.tosLink", + "description": "TOS\n\nTerms of service url of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.logoLink", + "description": "Logo\n\nLogo url of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.notificationEmail", + "description": "Notification Email\n\nNotification email of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.helpdeskEmail", + "description": "Helpdesk Email\n\nHelpdesk email of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.productName", + "description": "Product Name\n\nProduct Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.supportTeamName", + "description": "Support Team Name\n\nSupport Team Name", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.opsHost", + "description": "OPS Host\n\nOperations host of the partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.favIconLink", + "description": "Fav Icon Link\n\nFav Icon Link", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.isTOTPEnabled", + "description": "TOTP Enabled\n\nTOTP Enabled flag at the partner level", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "PartnerService" + ] + }, + "put": { + "operationId": "PartnerService_UpdatePartner", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Partner" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Partner", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3PartnerSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Partner", + "title": "Partner", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "PartnerService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "protobufNullValue": { + "type": "string", + "enum": [ + "NULL_VALUE" + ], + "default": "NULL_VALUE", + "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Partner": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Partner", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3PartnerSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Partner", + "title": "Partner", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3PartnerSpec": { + "type": "object", + "properties": { + "host": { + "type": "string", + "description": "Host of the partner", + "title": "Host" + }, + "domain": { + "type": "string", + "description": "Domain of the partner", + "title": "Domain" + }, + "tosLink": { + "type": "string", + "description": "Terms of service url of the partner", + "title": "TOS" + }, + "logoLink": { + "type": "string", + "description": "Logo url of the partner", + "title": "Logo" + }, + "notificationEmail": { + "type": "string", + "description": "Notification email of the partner", + "title": "Notification Email" + }, + "helpdeskEmail": { + "type": "string", + "description": "Helpdesk email of the partner", + "title": "Helpdesk Email" + }, + "productName": { + "type": "string", + "description": "Product Name", + "title": "Product Name" + }, + "supportTeamName": { + "type": "string", + "description": "Support Team Name", + "title": "Support Team Name" + }, + "opsHost": { + "type": "string", + "description": "Operations host of the partner", + "title": "OPS Host" + }, + "favIconLink": { + "type": "string", + "description": "Fav Icon Link", + "title": "Fav Icon Link" + }, + "isTOTPEnabled": { + "type": "boolean", + "description": "TOTP Enabled flag at the partner level", + "title": "TOTP Enabled" + }, + "settings": { + "type": "object", + "description": "Settings of the partner", + "title": "Settings" + } + }, + "description": "Partner Specification", + "title": "Partner Specification" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/project.swagger.json b/apis/project.swagger.json new file mode 100644 index 0000000..1eacf7f --- /dev/null +++ b/apis/project.swagger.json @@ -0,0 +1,1185 @@ +{ + "swagger": "2.0", + "info": { + "title": "Project Service", + "version": "3.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "ProjectService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/project": { + "post": { + "operationId": "ProjectService_CreateProject", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Project" + } + }, + "201": { + "description": "Returned when project is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Project", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ProjectSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Project", + "title": "Project", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name", + "project" + ] + } + } + ], + "tags": [ + "ProjectService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/project/{metadata.name}": { + "get": { + "operationId": "ProjectService_GetProject", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Project" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Project" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.default", + "description": "Default\n\nflag to indicate if this is the default project in the organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ProjectService" + ] + }, + "delete": { + "operationId": "ProjectService_DeleteProject", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Project" + } + }, + "204": { + "description": "Returned when project is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Project" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.default", + "description": "Default\n\nflag to indicate if this is the default project in the organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ProjectService" + ] + }, + "put": { + "operationId": "ProjectService_UpdateProject", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Project" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Project", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ProjectSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Project", + "title": "Project", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "ProjectService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/projects": { + "get": { + "operationId": "ProjectService_GetProjects", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3ProjectList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the resource", + "in": "query", + "required": true, + "type": "string", + "default": "Project" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.default", + "description": "Default\n\nflag to indicate if this is the default project in the organization", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "ProjectService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Project": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Project", + "description": "Kind of the resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3ProjectSpec", + "description": "Spec of the resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Project", + "title": "Project", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3ProjectList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "Project", + "description": "Kind of the list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the list resource", + "title": "ListMetadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Project", + "readOnly": true + }, + "description": "List of the resources", + "title": "Items" + } + }, + "description": "Project list", + "title": "ProjectList" + }, + "v3ProjectNamespaceRole": { + "type": "object", + "properties": { + "project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "namespace": { + "type": "string", + "description": "Namespace", + "title": "Namespace" + }, + "role": { + "type": "string", + "description": "Role", + "title": "Role" + }, + "group": { + "type": "string", + "description": "Group", + "title": "Group" + } + }, + "description": "Project, role and namespace pairing for permission", + "title": "ProjectNamespaceRole" + }, + "v3ProjectSpec": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "flag to indicate if this is the default project in the organization", + "title": "Default" + }, + "projectNamespaceRoles": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ProjectNamespaceRole" + }, + "description": "Project, namespace, role associations with groups", + "title": "ProjectNamespaceRoles" + }, + "userRoles": { + "type": "array", + "items": { + "$ref": "#/definitions/v3UserRole" + }, + "description": "List of users with roles assigned to projects", + "title": "UserRoles" + } + }, + "description": "project specification", + "title": "Project Specification" + }, + "v3UserRole": { + "type": "object", + "properties": { + "user": { + "type": "string", + "description": "User", + "title": "User" + }, + "role": { + "type": "string", + "description": "Role", + "title": "Role" + }, + "namespace": { + "type": "string", + "description": "Namespace", + "title": "Namespace" + } + }, + "description": "User, role, namespace pairing for permission", + "title": "UserRole" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/relayaudit.swagger.json b/apis/relayaudit.swagger.json new file mode 100644 index 0000000..95801c2 --- /dev/null +++ b/apis/relayaudit.swagger.json @@ -0,0 +1,1003 @@ +{ + "swagger": "2.0", + "info": { + "title": "Relay Audit Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "RelayAuditService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/event/v1/audit/relay": { + "get": { + "operationId": "RelayAuditService_GetRelayAuditByProjects", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1RelayAuditResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.clusterNames", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "auditType", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RelayAuditService" + ] + } + }, + "/event/v1/relayaudit": { + "get": { + "operationId": "RelayAuditService_GetRelayAPIAuditByProjects", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1RelayAuditResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.clusterNames", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "auditType", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RelayAuditService" + ] + } + }, + "/event/v1/{metadata.urlScope}/audit/relay": { + "get": { + "operationId": "RelayAuditService_GetRelayAudit", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1RelayAuditResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.urlScope", + "in": "path", + "required": true, + "type": "string", + "pattern": "project/[^/]+" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.clusterNames", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "auditType", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RelayAuditService" + ] + } + }, + "/event/v1/{metadata.urlScope}/relayaudit": { + "get": { + "operationId": "RelayAuditService_GetRelayAPIAudit", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v1RelayAuditResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.urlScope", + "in": "path", + "required": true, + "type": "string", + "pattern": "project/[^/]+" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization\n\nOrganization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner\n\nPartner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "filter.type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.client", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.timefrom", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.portal", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.cluster", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.namespace", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.kind", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.method", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.projects", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "filter.queryString", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.dashboardData", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.clusterNames", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "auditType", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RelayAuditService" + ] + } + } + }, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "protobufNullValue": { + "type": "string", + "enum": [ + "NULL_VALUE" + ], + "default": "NULL_VALUE", + "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." + }, + "v1RelayAuditQueryFilter": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "user": { + "type": "string" + }, + "client": { + "type": "string" + }, + "timefrom": { + "type": "string" + }, + "portal": { + "type": "string" + }, + "cluster": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "method": { + "type": "string" + }, + "projects": { + "type": "array", + "items": { + "type": "string" + } + }, + "queryString": { + "type": "string" + }, + "dashboardData": { + "type": "boolean" + }, + "clusterNames": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "v1RelayAuditResponse": { + "type": "object", + "properties": { + "result": { + "type": "object" + }, + "auditType": { + "type": "string" + } + } + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/relaypeer.swagger.json b/apis/relaypeer.swagger.json new file mode 100644 index 0000000..1fcc9d1 --- /dev/null +++ b/apis/relaypeer.swagger.json @@ -0,0 +1,94 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/rpc/sentry/relaypeer.proto", + "version": "version not set" + }, + "tags": [ + { + "name": "RelayPeerService" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "rpcPeerHelloResponse": { + "type": "object", + "properties": { + "serviceuuid": { + "type": "string" + }, + "serviceip": { + "type": "string" + } + } + }, + "rpcPeerProbeResponse": { + "type": "object", + "properties": { + "clustersni": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/rpcRelayClusterConnectionInfo" + } + } + }, + "title": "Probe Response from service to relay" + }, + "rpcPeerSurveyRequest": { + "type": "object", + "properties": { + "clustersni": { + "type": "string" + } + }, + "title": "Survey request sent from the service to all relays" + }, + "rpcRelayClusterConnectionInfo": { + "type": "object", + "properties": { + "relayuuid": { + "type": "string" + }, + "relayip": { + "type": "string" + } + } + } + } +} diff --git a/apis/role.swagger.json b/apis/role.swagger.json new file mode 100644 index 0000000..c92ecc1 --- /dev/null +++ b/apis/role.swagger.json @@ -0,0 +1,1205 @@ +{ + "swagger": "2.0", + "info": { + "title": "Role management Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "RoleService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/role/{metadata.name}": { + "get": { + "operationId": "RoleService_GetRole", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Role" + } + }, + "403": { + "description": "Returned when the role does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the Role resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the role resource", + "in": "query", + "required": true, + "type": "string", + "default": "Role" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.rolepermissions", + "description": "Role Permissions\n\nPermissions for the role", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.isGlobal", + "description": "IsGlobal\n\nSpecify if this is a global role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.scope", + "description": "Scope\n\nScope of role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.builtin", + "description": "Builtin\n\nSpecify if this is a builtin role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RoleService" + ] + }, + "delete": { + "operationId": "RoleService_DeleteRole", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Role" + } + }, + "204": { + "description": "Returned when role is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the role does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the Role resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the role resource", + "in": "query", + "required": true, + "type": "string", + "default": "Role" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.rolepermissions", + "description": "Role Permissions\n\nPermissions for the role", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.isGlobal", + "description": "IsGlobal\n\nSpecify if this is a global role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.scope", + "description": "Scope\n\nScope of role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.builtin", + "description": "Builtin\n\nSpecify if this is a builtin role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RoleService" + ] + }, + "put": { + "operationId": "RoleService_UpdateRole", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Role" + } + }, + "403": { + "description": "Returned when the role does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the Role resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Role", + "description": "Kind of the role resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3RoleSpec", + "description": "Spec of the role resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Role", + "title": "Role", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "project" + ] + } + } + ], + "tags": [ + "RoleService" + ] + } + }, + "/auth/v3/partner/{metadata.partner}/organization/{metadata.organization}/roles": { + "get": { + "operationId": "RoleService_GetRoles", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3RoleList" + } + }, + "403": { + "description": "Returned when the role does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version\n\nAPI Version of the Role resource", + "in": "query", + "required": true, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind\n\nKind of the role resource", + "in": "query", + "required": true, + "type": "string", + "default": "Role" + }, + { + "name": "metadata.name", + "description": "Name\n\nname of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name\n\ndisplay name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description\n\ndescription of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project\n\nProject of the resource", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.rolepermissions", + "description": "Role Permissions\n\nPermissions for the role", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.isGlobal", + "description": "IsGlobal\n\nSpecify if this is a global role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.scope", + "description": "Scope\n\nScope of role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.builtin", + "description": "Builtin\n\nSpecify if this is a builtin role", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "status.conditionType", + "description": "Condition Type\n\ntype of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status\n\nstatus of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated\n\nwhen the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason\n\nreason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RoleService" + ] + }, + "post": { + "operationId": "RoleService_CreateRole", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3Role" + } + }, + "201": { + "description": "Returned when role is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the role does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.partner", + "description": "Partner to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization to which the resource belongs", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the Role resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Role", + "description": "Kind of the role resource", + "title": "Kind" + }, + "metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3RoleSpec", + "description": "Spec of the role resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Role", + "title": "Role", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec", + "name", + "project" + ] + } + } + ], + "tags": [ + "RoleService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Role": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the Role resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "Role", + "description": "Kind of the role resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the role resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3RoleSpec", + "description": "Spec of the role resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Role", + "title": "Role", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3RoleList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "description": "API Version of the role list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Kind of the role list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the role list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Role", + "readOnly": true + }, + "description": "List of role resources", + "title": "Items" + } + }, + "description": "Role list", + "title": "RoleList", + "readOnly": true + }, + "v3RoleSpec": { + "type": "object", + "properties": { + "rolepermissions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Permissions for the role", + "title": "Role Permissions" + }, + "isGlobal": { + "type": "boolean", + "description": "Specify if this is a global role", + "title": "IsGlobal" + }, + "scope": { + "type": "string", + "description": "Scope of role", + "title": "Scope" + }, + "builtin": { + "type": "boolean", + "description": "Specify if this is a builtin role", + "title": "Builtin", + "readOnly": true + } + }, + "description": "Role specification", + "title": "Role Specification" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/rolepermission.swagger.json b/apis/rolepermission.swagger.json new file mode 100644 index 0000000..0e75557 --- /dev/null +++ b/apis/rolepermission.swagger.json @@ -0,0 +1,526 @@ +{ + "swagger": "2.0", + "info": { + "title": "Rolepermission management Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "RolepermissionService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/rolepermissions": { + "get": { + "operationId": "RolepermissionService_GetRolepermissions", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3RolePermissionList" + } + }, + "403": { + "description": "Returned when the rolepermission does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "q", + "description": "query for filtering", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "selector", + "description": "selector is used to filter the labels of a resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "description": "displayName only used for update queries to set displayName (READONLY)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value)", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "RolepermissionService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3RolePermission": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the role permission resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "RolePermission", + "description": "Kind of the role permission resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the role permission resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3RolePermissionSpec", + "description": "Metadata of the role permission resource", + "title": "Metadata" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "Role Permission", + "title": "RolePermission", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3RolePermissionList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "description": "API Version of the role permission list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Kind of the role permission list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the role permission list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3RolePermission", + "readOnly": true + }, + "description": "List of the role permission resources", + "title": "Items" + } + }, + "description": "RolePeList list", + "title": "RolePermissionList", + "readOnly": true + }, + "v3RolePermissionSpec": { + "type": "object", + "properties": { + "scope": { + "type": "string", + "description": "Scope of permisions for role", + "title": "Scope" + } + }, + "description": "RolePermisson specification", + "title": "RolePermission Specification" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/apis/sentry.swagger.json b/apis/sentry.swagger.json new file mode 100644 index 0000000..9a0388f --- /dev/null +++ b/apis/sentry.swagger.json @@ -0,0 +1,43 @@ +{ + "swagger": "2.0", + "info": { + "title": "proto/types/sentry/sentry.proto", + "version": "version not set" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + } + } +} diff --git a/apis/test.swagger.json b/apis/test.swagger.json new file mode 100644 index 0000000..0bf0b4a --- /dev/null +++ b/apis/test.swagger.json @@ -0,0 +1,113 @@ +{ + "swagger": "2.0", + "info": { + "title": "pkg/gateway/testdata/test.proto", + "version": "version not set" + }, + "tags": [ + { + "name": "TestService" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v3/test/{metadata.name}/test/{metadata.name}": { + "get": { + "operationId": "TestService_Get", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/testdataTestObject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/rpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "metadata.name", + "in": "path", + "required": true, + "type": "string" + } + ], + "tags": [ + "TestService" + ] + } + } + }, + "definitions": { + "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": "#/definitions/protobufAny" + } + } + } + }, + "testdataTestMetadata": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "testdataTestObject": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/testdataTestMetadata" + }, + "spec": { + "$ref": "#/definitions/testdataTestObjectSpec" + }, + "status": { + "$ref": "#/definitions/testdataTestObjectStatus" + } + } + }, + "testdataTestObjectSpec": { + "type": "object" + }, + "testdataTestObjectStatus": { + "type": "object" + } + } +} diff --git a/apis/user.swagger.json b/apis/user.swagger.json new file mode 100644 index 0000000..d8b2638 --- /dev/null +++ b/apis/user.swagger.json @@ -0,0 +1,1772 @@ +{ + "swagger": "2.0", + "info": { + "title": "User management Service", + "version": "2.0", + "contact": { + "name": "Paralus Dev" + } + }, + "tags": [ + { + "name": "UserService" + } + ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/auth/v3/cli/config": { + "get": { + "operationId": "UserService_DownloadCliConfig", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3HttpBody" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/user/{metadata.name}": { + "get": { + "operationId": "UserService_GetUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3User" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version. API Version of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind. Kind of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "User" + }, + { + "name": "metadata.displayName", + "description": "Display Name. display name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description. description of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project. Project of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization. Organization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner. Partner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.firstName", + "description": "FirstName. First name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastName", + "description": "LastName. Last name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone. Phone number of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.password", + "description": "Password. Password of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.groups", + "description": "Group. Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.idpGroups", + "description": "Idp Group. Idp Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.emailVerified", + "description": "EmailVerified. Flag to show if the email of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.phoneVerified", + "description": "PhoneVerified. Flag to show if phone number of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.recoveryUrl", + "description": "Recovery Url. Initial signup URL returned after user creation", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastLogin", + "description": "LastLogin. Last access date time in RFC3339 format.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type. type of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status. status of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated. when the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason. reason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + }, + "delete": { + "operationId": "UserService_DeleteUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserDeleteApiKeysResponse" + } + }, + "204": { + "description": "Returned when user is deleted successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "apiVersion", + "description": "API Version. API Version of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind. Kind of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "User" + }, + { + "name": "metadata.displayName", + "description": "Display Name. display name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description. description of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project. Project of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization. Organization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner. Partner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.firstName", + "description": "FirstName. First name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastName", + "description": "LastName. Last name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone. Phone number of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.password", + "description": "Password. Password of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.groups", + "description": "Group. Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.idpGroups", + "description": "Idp Group. Idp Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.emailVerified", + "description": "EmailVerified. Flag to show if the email of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.phoneVerified", + "description": "PhoneVerified. Flag to show if phone number of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.recoveryUrl", + "description": "Recovery Url. Initial signup URL returned after user creation", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastLogin", + "description": "LastLogin. Last access date time in RFC3339 format.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type. type of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status. status of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated. when the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason. reason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + }, + "put": { + "operationId": "UserService_UpdateUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3User" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "metadata.name", + "description": "name of the resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v3User" + } + } + ], + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/user/{username}/apikeys": { + "get": { + "operationId": "UserService_UserListApiKeys", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserListApiKeysResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "username", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/user/{username}/apikeys/{id}": { + "delete": { + "operationId": "UserService_UserDeleteApiKeys", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserDeleteApiKeysResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "username", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/user/{username}/forgotpassword": { + "get": { + "operationId": "UserService_UserForgotPassword", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserForgotPasswordResponse" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "username", + "in": "path", + "required": true, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/userinfo": { + "get": { + "operationId": "UserService_GetUserInfo", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserInfo" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "apiVersion", + "description": "API Version. API Version of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "system.k8smgmt.io/v3" + }, + { + "name": "kind", + "description": "Kind. Kind of the user resource", + "in": "query", + "required": false, + "type": "string", + "default": "User" + }, + { + "name": "metadata.name", + "description": "Name. name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.displayName", + "description": "Display Name. display name of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.description", + "description": "Description. description of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.project", + "description": "Project. Project of the resource", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.organization", + "description": "Organization. Organization to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.partner", + "description": "Partner. Partner to which the resource belongs", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.urlScope", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "metadata.createdAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "metadata.modifiedAt", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "spec.firstName", + "description": "FirstName. First name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastName", + "description": "LastName. Last name of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.phone", + "description": "Phone. Phone number of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.password", + "description": "Password. Password of the user", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.groups", + "description": "Group. Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.idpGroups", + "description": "Idp Group. Idp Groups the user belongs to", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "spec.emailVerified", + "description": "EmailVerified. Flag to show if the email of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.phoneVerified", + "description": "PhoneVerified. Flag to show if phone number of the user was verified", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "spec.recoveryUrl", + "description": "Recovery Url. Initial signup URL returned after user creation", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "spec.lastLogin", + "description": "LastLogin. Last access date time in RFC3339 format.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionType", + "description": "Condition Type. type of the status condition", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "status.conditionStatus", + "description": "Condition Status. status of the condition", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet" + }, + { + "name": "status.lastUpdated", + "description": "Last Updated. when the condition status is last updated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "status.reason", + "description": "Reason. reason of the last condition status", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + } + }, + "/auth/v3/users": { + "get": { + "operationId": "UserService_GetUsers", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3UserList" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "q", + "description": "query for filtering.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "name", + "description": "name is unique ID of a resource along with (partnerID, organizationID,\nprojectID).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "selector", + "description": "selector is used to filter the labels of a resource.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "partner", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "organization", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "project", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "role", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "displayName", + "description": "displayName only used for update queries to set displayName (READONLY).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + }, + { + "name": "ignoreScopeDefault", + "description": "ignoreScopeDefault ignores default values for partnerID, organizationID and\nprojectID.", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "globalScope", + "description": "globalScope sets partnerID,organizationID,projectID = 0.", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "deleted", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "extended", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "urlScope", + "description": "urlScope is supposed to be passed in the URL as kind/HashID(value).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "isSSOUser", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "username", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "groups", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "blueprintRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "publishedVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clusterID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ID", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "account", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "type", + "description": "generic way to specify a type of resource, mainly for use in users endpoint.", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "UserService" + ] + }, + "post": { + "operationId": "UserService_CreateUser", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/v3User" + } + }, + "201": { + "description": "Returned when user is created successfully.", + "schema": {} + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": {} + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "type": "string", + "format": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/googlerpcStatus" + } + } + }, + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v3User" + } + } + ], + "tags": [ + "UserService" + ] + } + } + }, + "definitions": { + "commonv3Status": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "type of the status condition", + "title": "Condition Type", + "readOnly": true + }, + "conditionStatus": { + "$ref": "#/definitions/v3ConditionStatus", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "description": "status of the condition", + "title": "Condition Status", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "when the condition status is last updated", + "title": "Last Updated", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "reason of the last condition status", + "title": "Reason", + "readOnly": true + } + }, + "description": "status of a resource", + "title": "Status", + "readOnly": true + }, + "googlerpcStatus": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/protobufAny" + } + } + } + }, + "protobufAny": { + "type": "object", + "properties": { + "@type": { + "type": "string" + } + }, + "additionalProperties": {} + }, + "v3ApiKeyResponse": { + "type": "object", + "properties": { + "modifiedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "v3ConditionStatus": { + "type": "string", + "enum": [ + "StatusNotSet", + "StatusSubmitted", + "StatusOK", + "StatusFailed" + ], + "default": "StatusNotSet", + "title": "$title: ConditionStatus\n$description: status of a condition for a resource" + }, + "v3HttpBody": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "The HTTP Content-Type header value specifying the content type of the body." + }, + "data": { + "type": "string", + "format": "byte", + "description": "The HTTP request/response body as raw binary." + } + }, + "title": "HttpBody represents arbitrary HTTP Body. It should only be used for\npayload formats that can't be represented as JSON" + }, + "v3ListMetadata": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" + }, + "offset": { + "type": "string", + "format": "int64" + }, + "limit": { + "type": "string", + "format": "int64" + } + }, + "title": "$title: ListMetadata\n$description: metadata for a list of resources\n$required: enabled" + }, + "v3Metadata": { + "type": "object", + "example": { + "name": "some-name", + "project": "defaultproject" + }, + "properties": { + "name": { + "type": "string", + "description": "name of the resource", + "title": "Name" + }, + "displayName": { + "type": "string", + "description": "display name of the resource", + "title": "Display Name" + }, + "description": { + "type": "string", + "description": "description of the resource", + "title": "Description" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "labels of the resource", + "title": "Labels" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "annotations of the resource", + "title": "Annotations" + }, + "project": { + "type": "string", + "description": "Project of the resource", + "title": "Project" + }, + "organization": { + "type": "string", + "description": "Organization to which the resource belongs", + "title": "Organization" + }, + "partner": { + "type": "string", + "description": "Partner to which the resource belongs", + "title": "Partner" + }, + "id": { + "type": "string", + "readOnly": true + }, + "urlScope": { + "type": "string", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "description": "metadata of the resource", + "title": "Metadata", + "required": [ + "name", + "project" + ] + }, + "v3Permission": { + "type": "object", + "properties": { + "project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "namespace": { + "type": "string", + "description": "Namespace", + "title": "Namespace" + }, + "role": { + "type": "string", + "description": "Role", + "title": "Role" + }, + "permissions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Permissions provided by role", + "title": "Permissions" + } + }, + "description": "Permissions", + "title": "Permissions" + }, + "v3ProjectNamespaceRole": { + "type": "object", + "properties": { + "project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "namespace": { + "type": "string", + "description": "Namespace", + "title": "Namespace" + }, + "role": { + "type": "string", + "description": "Role", + "title": "Role" + }, + "group": { + "type": "string", + "description": "Group", + "title": "Group" + } + }, + "description": "Project, role and namespace pairing for permission", + "title": "ProjectNamespaceRole" + }, + "v3User": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the user resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "User", + "description": "Kind of the user resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the user resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3UserSpec", + "description": "Spec of the user resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "User", + "title": "User", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3UserDeleteApiKeysResponse": { + "type": "object" + }, + "v3UserForgotPasswordResponse": { + "type": "object", + "properties": { + "recoveryLink": { + "type": "string" + } + } + }, + "v3UserInfo": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "system.k8smgmt.io/v3", + "description": "API Version of the user resource", + "title": "API Version" + }, + "kind": { + "type": "string", + "default": "User", + "description": "Kind of the user resource", + "title": "Kind" + }, + "metadata": { + "$ref": "#/definitions/v3Metadata", + "description": "Metadata of the user resource", + "title": "Metadata" + }, + "spec": { + "$ref": "#/definitions/v3UserInfoSpec", + "description": "Spec of the user resource", + "title": "Spec" + }, + "status": { + "$ref": "#/definitions/commonv3Status", + "description": "Status of the resource", + "title": "Status", + "readOnly": true + } + }, + "description": "User info", + "title": "UserInfo", + "required": [ + "apiVersion", + "kind", + "metadata", + "spec" + ] + }, + "v3UserInfoSpec": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the user", + "title": "FirstName" + }, + "lastName": { + "type": "string", + "description": "Last name of the user", + "title": "LastName" + }, + "phone": { + "type": "string", + "description": "Phone number of the user", + "title": "Phone" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Groups the user belongs to", + "title": "Group", + "readOnly": true + }, + "idpGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Idp Groups the user belongs to", + "title": "Idp Group", + "readOnly": true + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/v3Permission" + }, + "description": "Permissions for the user", + "title": "Permissions" + }, + "emailVerified": { + "type": "boolean", + "description": "Flag to show if the email of the user was verified", + "title": "EmailVerified", + "readOnly": true + }, + "phoneVerified": { + "type": "boolean", + "description": "Flag to show if phone number of the user was verified", + "title": "PhoneVerified", + "readOnly": true + } + }, + "description": "User info specification", + "title": "UserInfo Specification" + }, + "v3UserList": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "default": "usermgmt.k8smgmt.io/v3", + "description": "API Version of the user list resource", + "title": "API Version", + "readOnly": true + }, + "kind": { + "type": "string", + "default": "UserList", + "description": "Kind of the user list resource", + "title": "Kind", + "readOnly": true + }, + "metadata": { + "$ref": "#/definitions/v3ListMetadata", + "description": "Metadata of the user list resource", + "title": "Metadata", + "readOnly": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3User" + }, + "description": "List of the user resources", + "title": "Items", + "readOnly": true + } + }, + "description": "User list", + "title": "UserList", + "readOnly": true + }, + "v3UserListApiKeysResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ApiKeyResponse" + } + } + } + }, + "v3UserSpec": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the user", + "title": "FirstName" + }, + "lastName": { + "type": "string", + "description": "Last name of the user", + "title": "LastName" + }, + "phone": { + "type": "string", + "description": "Phone number of the user", + "title": "Phone" + }, + "password": { + "type": "string", + "description": "Password of the user", + "title": "Password" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Groups the user belongs to", + "title": "Group", + "readOnly": true + }, + "idpGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Idp Groups the user belongs to", + "title": "Idp Group", + "readOnly": true + }, + "projectNamespaceRoles": { + "type": "array", + "items": { + "$ref": "#/definitions/v3ProjectNamespaceRole" + }, + "description": "Project, namespace, role associations for user", + "title": "ProjectNamespaceRoles" + }, + "emailVerified": { + "type": "boolean", + "description": "Flag to show if the email of the user was verified", + "title": "EmailVerified", + "readOnly": true + }, + "phoneVerified": { + "type": "boolean", + "description": "Flag to show if phone number of the user was verified", + "title": "PhoneVerified", + "readOnly": true + }, + "recoveryUrl": { + "type": "string", + "description": "Initial signup URL returned after user creation", + "title": "Recovery Url", + "readOnly": true + }, + "lastLogin": { + "type": "string", + "description": "Last access date time in RFC3339 format.", + "title": "LastLogin", + "readOnly": true + } + }, + "description": "User specification", + "title": "User Specification" + } + }, + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-PARALUS-API-KEYID", + "in": "header" + }, + "BasicAuth": { + "type": "basic" + } + }, + "security": [ + { + "ApiKeyAuth": [], + "BasicAuth": [] + } + ] +} diff --git a/swagger-config.json b/swagger-config.json index 8b13789..5547956 100644 --- a/swagger-config.json +++ b/swagger-config.json @@ -1 +1 @@ - +{"urls":[{"name":"account_permission.swagger.json","url":"apis/account_permission.swagger.json"},{"name":"artifacts.swagger.json","url":"apis/artifacts.swagger.json"},{"name":"audit_info.swagger.json","url":"apis/audit_info.swagger.json"},{"name":"auditlog.swagger.json","url":"apis/auditlog.swagger.json"},{"name":"auth.swagger.json","url":"apis/auth.swagger.json"},{"name":"authz.swagger.json","url":"apis/authz.swagger.json"},{"name":"bootstrap.swagger.json","url":"apis/bootstrap.swagger.json"},{"name":"cluster.swagger.json","url":"apis/cluster.swagger.json"},{"name":"cluster_authz.swagger.json","url":"apis/cluster_authz.swagger.json"},{"name":"cluster_controller.swagger.json","url":"apis/cluster_controller.swagger.json"},{"name":"common.swagger.json","url":"apis/common.swagger.json"},{"name":"group.swagger.json","url":"apis/group.swagger.json"},{"name":"group_permission.swagger.json","url":"apis/group_permission.swagger.json"},{"name":"idp.swagger.json","url":"apis/idp.swagger.json"},{"name":"kubeconfig.swagger.json","url":"apis/kubeconfig.swagger.json"},{"name":"kubeconfig_setting.swagger.json","url":"apis/kubeconfig_setting.swagger.json"},{"name":"kubectl_cluster.swagger.json","url":"apis/kubectl_cluster.swagger.json"},{"name":"kubectl_cluster_setting.swagger.json","url":"apis/kubectl_cluster_setting.swagger.json"},{"name":"metro.swagger.json","url":"apis/metro.swagger.json"},{"name":"namespace.swagger.json","url":"apis/namespace.swagger.json"},{"name":"oidc_provider.swagger.json","url":"apis/oidc_provider.swagger.json"},{"name":"organization.swagger.json","url":"apis/organization.swagger.json"},{"name":"partner.swagger.json","url":"apis/partner.swagger.json"},{"name":"project.swagger.json","url":"apis/project.swagger.json"},{"name":"relayaudit.swagger.json","url":"apis/relayaudit.swagger.json"},{"name":"relaypeer.swagger.json","url":"apis/relaypeer.swagger.json"},{"name":"role.swagger.json","url":"apis/role.swagger.json"},{"name":"rolepermission.swagger.json","url":"apis/rolepermission.swagger.json"},{"name":"sentry.swagger.json","url":"apis/sentry.swagger.json"},{"name":"test.swagger.json","url":"apis/test.swagger.json"},{"name":"user.swagger.json","url":"apis/user.swagger.json"}]}