gitpod.v1.RunnerInteractionService

UpdateRunnerConfigurationSchema

Updates the configuration schema for a runner.

Use this method to:

  • Define configuration options
  • Update schema definitions
  • Set validation rules

Examples

  • Update schema:

    Updates runner configuration schema.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
    configSchema:
      version: "1.0"
      runnerConfig:
        - id: "region"
          name: "Region"
          description: "Deployment region"
          required: true
          string:
            default: "us-west"
            pattern: "^[a-z]+-[a-z]+-[0-9]+$"
        - id: "autoUpdate"
          name: "Auto Update"
          description: "Enable automatic updates"
          required: true
          bool:
            default: true
    
post/gitpod.v1.RunnerInteractionService/UpdateRunnerConfigurationSchema

Request body

configSchemaGitpodV1RunnerConfigurationSchema — unresolved $ref
runnerIdstring uuid

The runner's identity

Response

Success

GitpodV1UpdateRunnerConfigurationSchemaResponse required

Changes