openapi: 3.2.0 info: description: API Documentation title: Control-plane UI Coder Controller API version: '1.0' servers: - url: https://facetsdemo.console.facets.cloud description: Generated server url security: - basicAuth: [] tags: - name: ui-coder-controller paths: /cc-ui/v1/coder/stack/{stackName}/coder-eligibility: get: operationId: identifyCoderLaunchEligible parameters: - in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoderLaunchEligibilityResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Identify coder launch eligible x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/existing-branch: post: operationId: createWorkspaceWithExistingBranch_1 parameters: - in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceExistingBranchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Create workspace with existing branch 1 x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/new-branch: post: operationId: createWorkspaceWithNewBranch_1 parameters: - in: path name: stackName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceNewBranchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Create workspace with new branch 1 x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/existing-branch: post: operationId: createWorkspaceWithExistingBranch parameters: - in: path name: stackName required: true schema: type: string - in: path name: resourceType required: true schema: type: string - in: path name: resourceName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceExistingBranchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Create workspace with existing branch x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/new-branch: post: operationId: createWorkspaceWithNewBranch parameters: - in: path name: stackName required: true schema: type: string - in: path name: resourceType required: true schema: type: string - in: path name: resourceName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceNewBranchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Create workspace with new branch x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/workspaces: get: operationId: getAll_4 parameters: - in: path name: stackName required: true schema: type: string - in: path name: resourceType required: true schema: type: string - in: path name: resourceName required: true schema: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Get all 4 x-summary-source: derived /cc-ui/v1/coder/stack/{stackName}/workspaces: get: operationId: getAll_3 parameters: - in: path name: stackName required: true schema: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CoderWorkspaceResponse' description: OK '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorDetails' - $ref: '#/components/schemas/GithubAppPermissionsPendingErrorDetails' description: Bad Request '403': content: application/json: schema: type: string description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Method Not Allowed '409': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' description: Internal Server Error tags: - ui-coder-controller summary: Get all 3 x-summary-source: derived components: schemas: GithubAppPermissionsPendingErrorDetails: type: object properties: approvalUrl: type: string code: type: string errorCode: type: string message: type: string missingPermissions: type: array items: type: string CreateWorkspaceExistingBranchRequest: required: - existingBranch - workspaceName type: object properties: existingBranch: type: string workspaceName: type: string CoderWorkspaceResponse: type: object properties: name: type: string url: type: string workspaceId: type: string CoderLaunchEligibilityResponse: type: object properties: coderAccountPresent: type: boolean userVCSTokenPresent: type: boolean ErrorDetails: type: object properties: code: type: string message: type: string CreateWorkspaceNewBranchRequest: required: - newBranch - sourceBranch - workspaceName type: object properties: newBranch: type: string sourceBranch: type: string workspaceName: type: string securitySchemes: basicAuth: description: Basic Authentication scheme: basic type: http