openapi: 3.0.1 info: title: yatai api server admin api v1 cluster resource API description: This is yatai api server. version: 1.0.0 tags: - name: cluster resource description: cluster resource paths: /api/v1/clusters/{clusterName}: get: tags: - cluster resource summary: Get a cluster operationId: Get a cluster parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: config: type: string nullable: true created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time default_deployment_kube_namespace: type: string deleted_at: type: string format: date-time nullable: true description: type: string grafana_root_path: type: string host_cluster_display_name: type: string host_cluster_name: type: string is_first: type: boolean kube_config: type: string nullable: true labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' multi_tenancy: type: boolean name: type: string organization: type: object properties: created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true description: type: string disable_grafana: type: boolean disable_resources_graphs: type: boolean enable_endpoints: type: boolean enable_mixture_scaling: type: boolean enable_monitoring_endpoint: type: boolean expired_at: type: string format: date-time nullable: true labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' limit_group: type: string nullable: true multi_tenancy: type: boolean name: type: string public: type: boolean resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token status: type: string uid: type: string updated_at: type: string format: date-time organization_name: type: string provider: type: string resource_instances: type: array items: type: object properties: config: type: string nullable: true created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true description: type: string display_name: type: string labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' lago_id: type: string name: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time patch: tags: - cluster resource summary: Update a cluster operationId: Update a cluster parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Update A ClusterInput' responses: '200': description: OK content: application/json: schema: type: object properties: config: type: string nullable: true created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time default_deployment_kube_namespace: type: string deleted_at: type: string format: date-time nullable: true description: type: string grafana_root_path: type: string host_cluster_display_name: type: string host_cluster_name: type: string is_first: type: boolean kube_config: type: string nullable: true labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' multi_tenancy: type: boolean name: type: string organization: type: object properties: created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true description: type: string disable_grafana: type: boolean disable_resources_graphs: type: boolean enable_endpoints: type: boolean enable_mixture_scaling: type: boolean enable_monitoring_endpoint: type: boolean expired_at: type: string format: date-time nullable: true labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' limit_group: type: string nullable: true multi_tenancy: type: boolean name: type: string public: type: boolean resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token status: type: string uid: type: string updated_at: type: string format: date-time organization_name: type: string provider: type: string resource_instances: type: array items: type: object properties: config: type: string nullable: true created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true description: type: string display_name: type: string labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' lago_id: type: string name: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time /api/v1/clusters/{clusterName}/members: get: tags: - cluster resource summary: List cluster members operationId: List cluster members parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Schemasv1ClusterMemberSchema' post: tags: - cluster resource summary: Create a cluster member operationId: Create a cluster member parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Create A Cluster MemberInput' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Schemasv1ClusterMemberSchema' delete: tags: - cluster resource summary: Remove a cluster member operationId: Remove a cluster member parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Schemasv1ClusterMemberSchema' /api/v1/clusters/{clusterName}/standby_instances: patch: tags: - cluster resource summary: Update standby instances operationId: Update standby instances parameters: - name: clusterName in: path required: true schema: type: string - name: X-Yatai-Organization in: header schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Update Standby InstancesInput' responses: '200': description: OK content: application/json: schema: type: object properties: created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time default_deployment_kube_namespace: type: string deleted_at: type: string format: date-time nullable: true description: type: string grafana_root_path: type: string host_cluster_display_name: type: string host_cluster_name: type: string is_first: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' multi_tenancy: type: boolean name: type: string organization_name: type: string provider: type: string resource_instance_names: type: array items: $ref: '#/components/schemas/Schemasv1ResourceInstanceName' resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token standby_instances: type: object additionalProperties: type: integer format: int32 uid: type: string updated_at: type: string format: date-time components: schemas: Update A ClusterInput: type: object properties: config: type: string nullable: true description: type: string nullable: true host_cluster_id: type: integer format: int32 nullable: true multi_tenancy: type: boolean Create A Cluster MemberInput: type: object properties: role: type: string enum: - guest - developer - admin - api_user usernames: type: array items: type: string ModelschemasLabelItemSchema: type: object properties: key: type: string stage: type: string value: type: string Update Standby InstancesInput: type: object properties: standby_instances: type: object additionalProperties: type: integer format: int32 Schemasv1ClusterMemberSchema: type: object properties: cluster: type: object properties: created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time default_deployment_kube_namespace: type: string deleted_at: type: string format: date-time nullable: true description: type: string grafana_root_path: type: string host_cluster_display_name: type: string host_cluster_name: type: string is_first: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' multi_tenancy: type: boolean name: type: string organization_name: type: string provider: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time created_at: type: string format: date-time creator: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true role: type: string uid: type: string updated_at: type: string format: date-time user: type: object properties: application_status: type: string avatar_url: type: string created_at: type: string format: date-time deleted_at: type: string format: date-time nullable: true email: type: string first_name: type: string from_sso: type: boolean is_super_admin: type: boolean labels: type: array items: $ref: '#/components/schemas/ModelschemasLabelItemSchema' last_name: type: string name: type: string perm: type: string register_stage: type: string resource_type: type: string enum: - user - organization - cluster - host_cluster - bento_repository - bento - deployment - deployment_revision - model_repository - model - api_token uid: type: string updated_at: type: string format: date-time Schemasv1ResourceInstanceName: type: object properties: display_name: type: string name: type: string securitySchemes: apiToken: type: apiKey in: header name: X-YATAI-API-TOKEN