Gitpod gitpod.v1.WorkflowService API

The gitpod.v1.WorkflowService API from Gitpod — 16 operation(s) for gitpod.v1.workflowservice.

OpenAPI Specification

gitpod-gitpod-v1-workflowservice-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: gitpod.v1 gitpod.v1.AccountService gitpod.v1.WorkflowService API
  version: v1.0.0
servers:
- url: https://api.gitpod.io
  description: Gitpod API
tags:
- name: gitpod.v1.WorkflowService
  x-displayName: gitpod.v1.WorkflowService
paths:
  /gitpod.v1.WorkflowService/CancelWorkflowExecution:
    servers: []
    post:
      description: "Cancels a running workflow execution.\n\n Use this method to:\n - Stop long-running executions\n - Cancel failed executions\n - Manage resource usage\n\n ### Examples\n\n - Cancel execution:\n\n   Stops a running workflow execution.\n\n   ```yaml\n   workflowExecutionId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n   ```"
      operationId: gitpod.v1.WorkflowService.CancelWorkflowExecution
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              cancel_execution:
                description: Stops a running workflow execution.
                value:
                  workflowExecutionId: d2c94c27-3b76-4a42-b88c-95a85e392c68
            schema:
              $ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: CancelWorkflowExecution
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/CancelWorkflowExecutionAction:
    servers: []
    post:
      description: "Cancels a running workflow execution action.\n\n Use this method to:\n - Stop long-running actions\n - Cancel failed actions\n - Manage resource usage\n\n ### Examples\n\n - Cancel execution action:\n\n   Stops a running workflow execution action.\n\n   ```yaml\n   workflowExecutionActionId: \"a1b2c3d4-5e6f-7890-abcd-ef1234567890\"\n   ```"
      operationId: gitpod.v1.WorkflowService.CancelWorkflowExecutionAction
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              cancel_execution_action:
                description: Stops a running workflow execution action.
                value:
                  workflowExecutionActionId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
            schema:
              $ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionActionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionActionResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: CancelWorkflowExecutionAction
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/CreateWorkflow:
    servers: []
    post:
      description: "Creates a new workflow with specified configuration.\n\n Use this method to:\n - Set up automated workflows\n - Configure workflow triggers\n - Define workflow actions and steps\n - Set execution limits and constraints"
      operationId: gitpod.v1.WorkflowService.CreateWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gitpod.v1.CreateWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.CreateWorkflowResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: CreateWorkflow
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/DeleteWorkflow:
    servers: []
    post:
      description: "Deletes a workflow permanently.\n\n Use this method to:\n - Remove unused workflows\n - Clean up test workflows\n - Delete obsolete configurations\n\n ### Examples\n\n - Delete workflow:\n\n   Permanently removes a workflow.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   ```"
      operationId: gitpod.v1.WorkflowService.DeleteWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              delete_workflow:
                description: Permanently removes a workflow.
                value:
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.DeleteWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.DeleteWorkflowResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: DeleteWorkflow
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/GetWorkflow:
    servers: []
    post:
      description: "Gets details about a specific workflow.\n\n Use this method to:\n - View workflow configuration\n - Check workflow status\n - Get workflow metadata\n\n ### Examples\n\n - Get workflow details:\n\n   Retrieves information about a specific workflow.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   ```"
      operationId: gitpod.v1.WorkflowService.GetWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              get_workflow_details:
                description: Retrieves information about a specific workflow.
                value:
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.GetWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.GetWorkflowResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: GetWorkflow
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/GetWorkflowExecution:
    servers: []
    post:
      description: "Gets details about a specific workflow execution.\n\n Use this method to:\n - Check execution status\n - View execution results\n - Monitor execution progress\n\n ### Examples\n\n - Get execution details:\n\n   Retrieves information about a specific execution.\n\n   ```yaml\n   workflowExecutionId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n   ```"
      operationId: gitpod.v1.WorkflowService.GetWorkflowExecution
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              get_execution_details:
                description: Retrieves information about a specific execution.
                value:
                  workflowExecutionId: d2c94c27-3b76-4a42-b88c-95a85e392c68
            schema:
              $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: GetWorkflowExecution
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/GetWorkflowExecutionAction:
    servers: []
    post:
      description: "Gets details about a specific workflow execution action.\n\n Use this method to:\n - Check execution action status\n - View execution action results\n - Monitor execution action progress\n\n ### Examples\n\n - Get execution action details:\n\n   Retrieves information about a specific execution action.\n\n   ```yaml\n   workflowExecutionActionId: \"a1b2c3d4-5e6f-7890-abcd-ef1234567890\"\n   ```"
      operationId: gitpod.v1.WorkflowService.GetWorkflowExecutionAction
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              get_execution_action_details:
                description: Retrieves information about a specific execution action.
                value:
                  workflowExecutionActionId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
            schema:
              $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionActionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionActionResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: GetWorkflowExecutionAction
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/GetWorkflowExecutionSummary:
    servers: []
    post:
      description: "Returns aggregate counts of workflow executions within a time range.\n\n Use this method to:\n - Get a summary of successful, failed, and total executions\n - Build dashboard views of automation activity\n\n ### Examples\n\n - Get execution summary for the last 7 days:\n\n   ```yaml\n   filter:\n     dateRange:\n       startTime: \"2026-03-05T00:00:00Z\"\n       endTime: \"2026-03-12T00:00:00Z\"\n   ```\n\n - Get execution summary for specific workflows:\n\n   ```yaml\n   filter:\n     dateRange:\n       startTime: \"2026-03-01T00:00:00Z\"\n       endTime: \"2026-03-12T00:00:00Z\"\n     workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n   ```"
      operationId: gitpod.v1.WorkflowService.GetWorkflowExecutionSummary
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              get_execution_summary_for_specific_workflows:
                description: "filter:\n  dateRange:\n    startTime: \"2026-03-01T00:00:00Z\"\n    endTime: \"2026-03-12T00:00:00Z\"\n  workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n"
                value:
                  filter:
                    dateRange:
                      endTime: '2026-03-12T00:00:00Z'
                      startTime: '2026-03-01T00:00:00Z'
                    workflowIds:
                    - b0e12f6c-4c67-429d-a4a6-d9838b5da047
              get_execution_summary_for_the_last_7_days:
                description: "filter:\n  dateRange:\n    startTime: \"2026-03-05T00:00:00Z\"\n    endTime: \"2026-03-12T00:00:00Z\"\n"
                value:
                  filter:
                    dateRange:
                      endTime: '2026-03-12T00:00:00Z'
                      startTime: '2026-03-05T00:00:00Z'
            schema:
              $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionSummaryRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionSummaryResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: GetWorkflowExecutionSummary
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/GetWorkflowWebhookSecret:
    servers: []
    post:
      description: "Gets the webhook secret for a workflow.\n\n This operation is audited for security purposes.\n\n Use this method to:\n - Retrieve webhook secret for configuration\n - Set up webhook integrations\n - Verify webhook signatures\n\n ### Examples\n\n - Get webhook secret:\n\n   Retrieves the webhook secret for a workflow.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   ```"
      operationId: gitpod.v1.WorkflowService.GetWorkflowWebhookSecret
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              get_webhook_secret:
                description: Retrieves the webhook secret for a workflow.
                value:
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.GetWorkflowWebhookSecretRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.GetWorkflowWebhookSecretResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: GetWorkflowWebhookSecret
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/ListWorkflowExecutionActions:
    servers: []
    post:
      description: "Lists workflow execution actions with optional filtering.\n\n Use this method to:\n - Monitor individual action execution status\n - Debug action failures\n - Track resource usage per action\n\n ### Examples\n\n - List execution actions for workflow execution:\n\n   Shows all execution actions for a specific workflow execution.\n\n   ```yaml\n   filter:\n     workflowExecutionIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n   pagination:\n     pageSize: 20\n   ```"
      operationId: gitpod.v1.WorkflowService.ListWorkflowExecutionActions
      parameters:
      - in: query
        name: pageSize
        schema:
          default: 25
          maximum: 100
          minimum: 0
          type: integer
      - in: query
        name: token
        schema:
          default: ''
          type: string
      requestBody:
        content:
          application/json:
            examples:
              list_execution_actions_for_workflow_execution:
                description: Shows all execution actions for a specific workflow execution.
                value:
                  filter:
                    workflowExecutionIds:
                    - d2c94c27-3b76-4a42-b88c-95a85e392c68
                  pagination:
                    pageSize: 20
            schema:
              $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionActionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionActionsResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: ListWorkflowExecutionActions
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs:
    servers: []
    post:
      description: "Lists outputs produced by workflow execution actions.\n\n Use this method to:\n - Retrieve test results, coverage metrics, or other structured data from executions\n - Aggregate outputs across multiple workflow executions\n - Build dashboards or reports from execution data\n\n ### Examples\n\n - List outputs for a workflow execution:\n\n   Retrieves all outputs produced by actions in the specified execution.\n\n   ```yaml\n   filter:\n     workflowExecutionIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n   pagination:\n     pageSize: 50\n   ```"
      operationId: gitpod.v1.WorkflowService.ListWorkflowExecutionOutputs
      parameters:
      - in: query
        name: pageSize
        schema:
          default: 25
          maximum: 100
          minimum: 0
          type: integer
      - in: query
        name: token
        schema:
          default: ''
          type: string
      requestBody:
        content:
          application/json:
            examples:
              list_outputs_for_a_workflow_execution:
                description: Retrieves all outputs produced by actions in the specified execution.
                value:
                  filter:
                    workflowExecutionIds:
                    - d2c94c27-3b76-4a42-b88c-95a85e392c68
                  pagination:
                    pageSize: 50
            schema:
              $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: ListWorkflowExecutionOutputs
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/ListWorkflowExecutions:
    servers: []
    post:
      description: "Lists workflow executions with optional filtering.\n\n Use this method to:\n - Monitor workflow execution history\n - Track execution status\n - Debug workflow issues\n\n ### Examples\n\n - List executions for workflow:\n\n   Shows all executions for a specific workflow.\n\n   ```yaml\n   filter:\n     workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n   pagination:\n     pageSize: 20\n   ```"
      operationId: gitpod.v1.WorkflowService.ListWorkflowExecutions
      parameters:
      - in: query
        name: pageSize
        schema:
          default: 25
          maximum: 100
          minimum: 0
          type: integer
      - in: query
        name: token
        schema:
          default: ''
          type: string
      requestBody:
        content:
          application/json:
            examples:
              list_executions_for_workflow:
                description: Shows all executions for a specific workflow.
                value:
                  filter:
                    workflowIds:
                    - b0e12f6c-4c67-429d-a4a6-d9838b5da047
                  pagination:
                    pageSize: 20
            schema:
              $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionsResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: ListWorkflowExecutions
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/ListWorkflows:
    servers: []
    post:
      operationId: gitpod.v1.WorkflowService.ListWorkflows
      parameters:
      - in: query
        name: pageSize
        schema:
          default: 25
          maximum: 100
          minimum: 0
          type: integer
      - in: query
        name: token
        schema:
          default: ''
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gitpod.v1.ListWorkflowsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.ListWorkflowsResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: ListWorkflows
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/RotateWorkflowWebhookSecret:
    servers: []
    post:
      description: "Rotates the webhook secret for a workflow.\n\n Use this method to:\n - Generate a new webhook secret\n - Invalidate the old webhook secret\n\n ### Examples\n\n - Rotate webhook secret:\n\n   Generates a new webhook secret for the workflow.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   ```"
      operationId: gitpod.v1.WorkflowService.RotateWorkflowWebhookSecret
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              rotate_webhook_secret:
                description: Generates a new webhook secret for the workflow.
                value:
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.RotateWorkflowWebhookSecretRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.RotateWorkflowWebhookSecretResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: RotateWorkflowWebhookSecret
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/StartWorkflow:
    servers: []
    post:
      description: "Starts a workflow execution.\n\n Use this method to:\n - Start workflow execution on demand\n - Test workflow configurations\n - Run workflows outside of automatic triggers\n\n ### Examples\n\n - Start workflow:\n\n   Starts a workflow execution manually.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   ```"
      operationId: gitpod.v1.WorkflowService.StartWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              start_workflow:
                description: Starts a workflow execution manually.
                value:
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.StartWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.StartWorkflowResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: StartWorkflow
      tags:
      - gitpod.v1.WorkflowService
  /gitpod.v1.WorkflowService/UpdateWorkflow:
    servers: []
    post:
      description: "Updates a workflow's configuration using full replacement semantics.\n\n Update Behavior:\n - All provided fields completely replace existing values\n - Optional fields that are not provided remain unchanged\n - Complex fields (triggers, action) are replaced entirely, not merged\n - To remove optional fields, explicitly set them to empty/default values\n\n Use this method to:\n - Modify workflow settings\n - Update triggers and actions\n - Change execution limits\n - Update workflow steps\n\n ### Examples\n\n - Update workflow name:\n\n   Changes the workflow's display name.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   name: \"Updated Workflow Name\"\n   ```\n\n - Replace all triggers:\n\n   Completely replaces the workflow's trigger configuration.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   triggers:\n     - manual: {}\n       context:\n         projects:\n           projectIds: [\"new-project-id\"]\n   ```\n\n - Update execution limits:\n\n   Completely replaces the workflow's action configuration.\n\n   ```yaml\n   workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n   action:\n     limits:\n       maxParallel: 10\n       maxTotal: 100\n     steps:\n       - task:\n           command: \"npm test\"\n   ```"
      operationId: gitpod.v1.WorkflowService.UpdateWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            examples:
              replace_all_triggers:
                description: Completely replaces the workflow's trigger configuration.
                value:
                  triggers:
                  - context:
                      projects:
                        projectIds:
                        - new-project-id
                    manual: {}
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
              update_execution_limits:
                description: Completely replaces the workflow's action configuration.
                value:
                  action:
                    limits:
                      maxParallel: 10
                      maxTotal: 100
                    steps:
                    - task:
                        command: npm test
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
              update_workflow_name:
                description: Changes the workflow's display name.
                value:
                  name: Updated Workflow Name
                  workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
            schema:
              $ref: '#/components/schemas/gitpod.v1.UpdateWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gitpod.v1.UpdateWorkflowResponse'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
          description: Error
      security:
      - bearerAuth: []
      summary: UpdateWorkflow
      tags:
      - gitpod.v1.WorkflowService
components:
  schemas:
    gitpod.v1.WorkflowErrorCode:
      description: "WorkflowErrorCode defines error codes specific to workflows.\n These codes help distinguish retriable vs non-retriable errors and provide actionable information\n to both the reconciler and the frontend.\n\n Error code ranges:\n - 0: Unspecified\n - 1-999: Reserved for future use\n - 1000-1999: Environment-related errors\n - 2000-2999: Agent-related errors\n - 3000-3999: Resource-related errors"
      enum:
      - WORKFLOW_ERROR_CODE_UNSPECIFIED
      - WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR
      - WORKFLOW_ERROR_CODE_AGENT_ERROR
      title: WorkflowErrorCode
      type: string
    gitpod.v1.GetWorkflowWebhookSecretResponse:
      additionalProperties: false
      properties:
        secret:
          description: The decrypted webhook secret
          title: secret
          type: string
      title: GetWorkflowWebhookSecretResponse
      type: object
    gitpod.v1.WorkflowExecutionAction.Metadata:
      additionalProperties: false
      description: WorkflowExecutionActionMetadata contains workflow execution action metadata.
      properties:
        actionName:
          description: "Human-readable name for this action based on its context.\n Examples: \"gitpod-io/gitpod-next\" for repository context, \"My Project\" for project context.\n Will be empty string for actions created before this field was added."
          title: action_name
          type: string
        finishedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: finished_at
        startedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: started_at
        workflowExecutionId:
          format: uuid
          title: workflow_execution_id
          type: string
        workflowId:
          format: uuid
          title: workflow_id
          type: string
      title: Metadata
      type: object
    gitpod.v1.UpdateWorkflowResponse:
      additionalProperties: false
      properties:
        workflow:
          $ref: '#/components/schemas/gitpod.v1.Workflow'
          title: workflow
      title: UpdateWorkflowResponse
      type: object
    gitpod.v1.WorkflowStep:
      additionalProperties: false
      description: WorkflowStep defines a single step in a workflow action.
      oneOf:
      - not:
          anyOf:
          - required:
            - pullRequest
          - required:
            - report
          - required:
            - task
        required:
        - agent
      - not:
          anyOf:
          - required:
            - agent
          - required:
            - report
          - required:
            - task
        required:
        - pullRequest
      - not:
          anyOf:
          - required:
            - agent
          - required:
            - pullRequest
          - required:
            - task
        required:
        - report
      - not:
          anyOf:
          - required:
            - agent
          - required:
            - pullRequest
          - required:
            - report
        required:
        - task
      properties:
        agent:
          $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Agent'
          title: agent
        pullRequest:
          $ref: '#/components/schemas/gitpod.v1.WorkflowStep.PullRequest'
          title: pull_request
        report:
          $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report'
          title: report
        task:
          $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Task'
          title: task
      title: WorkflowStep
      type: object
    gitpod.v1.GetWorkflowExecutionActionResponse:
      additionalProperties: false
      properties:
        workflowExecutionAction:
          $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction'
          title: workflow_execution_action
      title: GetWorkflowExecutionActionResponse
      type: object
    gitpod.v1.WorkflowExecutionTrigger:
      additionalProperties: false
      description: WorkflowExecutionTrigger represents a workflow execution trigger instance.
      oneOf:
      - not:
          anyOf:
          - required:
            - pullRequest
          - required:
            - time
        required:
        - manual
      - not:
          anyOf:
          - required:
            - manual
          - required:
            - time
        required:
        - pullRequest
      - not:
          anyOf:
          - required:
            - manual
          - required:
            - pullRequest
        required:
        - time
      properties:
        context:
          $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext'
          description: "Context from the workflow trigger - copied at execution time for immutability.\n This allows the reconciler to create actions without fetching the workflow definition."
          title: context
        manual:
          $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionTrigger.Manual'
          title: manual
        pullRequest:
          $ref: '#/components/schemas/gitpod.v1.PullRequest'
          title: pull_request
        time:
          $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionTrigger.Time'
          title: time
      required:
      - context
      title: WorkflowExecutionTrigger
      type: object
    gitpod.v1.Subject:
      additi

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitpod/refs/heads/main/openapi/gitpod-gitpod-v1-workflowservice-api-openapi.yml