API Evangelist conversational phrasing for Bitbucket Pipelines API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitbucket Pipelines API
  version: 1.0.0
extends: openapi/bitbucket-pipelines-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 68
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List variables for a deployment environment
      effect: read
      questions:
      - Which variables are set on my staging deployment environment?
      - Can I see the environment-level variables a deployment step will pick up?
      instructions:
      - text: List the variables on deployment environment {environment_uuid} in {workspace}/{repo_slug}.
        slots:
          environment_uuid: path.environment_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me every environment-level variable for environment {environment_uuid} of repo {repo_slug}.
        slots:
          environment_uuid: path.environment_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a variable to a deployment environment
      effect: write
      questions:
      - How do I add a secret just for my production deployment environment?
      - Can a deployment environment variable be marked as secured so its value is hidden?
      instructions:
      - text: Add variable {key} with value {value} to deployment environment {environment_uuid} in {workspace}/{repo_slug}.
        slots:
          key: requestBody.key
          value: requestBody.value
          environment_uuid: path.environment_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Create a secured environment variable {key} on environment {environment_uuid} of repo {repo_slug} in {workspace}.
        slots:
          key: requestBody.key
          environment_uuid: path.environment_uuid
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a deployment environment variable
      effect: write
      questions:
      - How do I change the value of an existing variable on a deployment environment?
      - Can I flip an environment variable I already created to secured?
      instructions:
      - text: Set environment variable {variable_uuid} on environment {environment_uuid} in {workspace}/{repo_slug} to {value}.
        slots:
          variable_uuid: path.variable_uuid
          environment_uuid: path.environment_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
          value: requestBody.value
      - text: Rename deployment environment variable {variable_uuid} in environment {environment_uuid} to {key}; repo {workspace}/{repo_slug}.
        slots:
          variable_uuid: path.variable_uuid
          environment_uuid: path.environment_uuid
          key: requestBody.key
          workspace: path.workspace
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a variable from a deployment environment
      effect: destructive
      questions:
      - How do I remove a variable that's only defined on one deployment environment?
      - What happens to a deployment environment when I delete one of its variables?
      instructions:
      - text: Delete variable {variable_uuid} from deployment environment {environment_uuid} in {workspace}/{repo_slug}.
        slots:
          variable_uuid: path.variable_uuid
          environment_uuid: path.environment_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove environment-level variable {variable_uuid} from environment {environment_uuid} of repo {repo_slug}.
        slots:
          variable_uuid: path.variable_uuid
          environment_uuid: path.environment_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipeline runs in a repository
      effect: read
      questions:
      - Which pipelines have run on my main branch recently?
      - Can I filter a repo's pipeline runs by status or by what triggered them?
      - How do I find the pipelines that ran against a specific commit hash?
      instructions:
      - text: List pipelines in {workspace}/{repo_slug} for branch {branch}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          branch: query.target.branch
      - text: Show pipeline runs in {workspace}/{repo_slug} with status {status}, sorted by {sort}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          status: query.status
          sort: query.sort
      - text: Find pipelines in repo {repo_slug} that ran on commit {hash}.
        slots:
          repo_slug: path.repo_slug
          hash: query.target.commit.hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a pipeline
      effect: write
      questions:
      - How do I trigger a Bitbucket pipeline run from the API?
      - Can I kick off a pipeline on a branch and pass it custom variables?
      instructions:
      - text: Run a pipeline in {workspace}/{repo_slug} against target {target}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          target: requestBody.target
      - text: Start a pipeline on {repo_slug} in {workspace} for target {target} with variables {variables}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          target: requestBody.target
          variables: requestBody.variables
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's pipeline caches
      effect: read
      questions:
      - What dependency caches are my pipelines storing for this repo?
      - Can I see how big each pipeline cache is before clearing them?
      instructions:
      - text: List the pipeline caches for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all build caches stored for repo {repo_slug} in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear pipeline caches by name
      effect: destructive
      questions:
      - How do I wipe every version of the node cache for my pipelines?
      - Can I clear a cache by its name rather than by its UUID?
      instructions:
      - text: Delete all versions of pipeline cache {name} in {workspace}/{repo_slug}.
        slots:
          name: query.name
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Clear the cache named {name} for repo {repo_slug} in {workspace}.
        slots:
          name: query.name
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single pipeline cache
      effect: destructive
      questions:
      - How do I delete just one specific cache entry from my pipelines by its ID?
      - Is there a way to drop one corrupted pipeline cache without touching the others?
      instructions:
      - text: Delete pipeline cache {cache_uuid} from {workspace}/{repo_slug}.
        slots:
          cache_uuid: path.cache_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the single cache {cache_uuid} in repo {repo_slug}.
        slots:
          cache_uuid: path.cache_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the download link for a pipeline cache
      effect: read
      questions:
      - Where can I download the contents of a pipeline cache?
      - Can I get a URI to inspect what's inside a cached dependency archive?
      instructions:
      - text: Get the content URI for cache {cache_uuid} in {workspace}/{repo_slug}.
        slots:
          cache_uuid: path.cache_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Give me the download link for pipeline cache {cache_uuid} of repo {repo_slug}.
        slots:
          cache_uuid: path.cache_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/runners'].get
  update:
    x-apievangelist-phrasing:
      intent: List self-hosted runners for a repository
      effect: read
      questions:
      - Which self-hosted runners are registered to this repository?
      - Can I see the status of runners attached at the repo level?
      instructions:
      - text: List the repository runners for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show self-hosted runners registered on repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/runners'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a self-hosted runner on a repository
      effect: write
      questions:
      - How do I register a new self-hosted runner scoped to one repo?
      - Can I add a runner to a single repository instead of the whole workspace?
      instructions:
      - text: Create a repository runner for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Register a new self-hosted runner on repo {repo_slug} in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository runner
      effect: read
      questions:
      - What are the details and state of one repo-level runner?
      - Can I check whether a particular repository runner is online?
      instructions:
      - text: Get repository runner {runner_uuid} in {workspace}/{repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me the details of runner {runner_uuid} attached to repo {repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a repository runner
      effect: write
      questions:
      - How do I change the settings of a runner registered on a repo?
      - Can I rename or relabel an existing repository runner?
      instructions:
      - text: Update repository runner {runner_uuid} in {workspace}/{repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Modify the repo-level runner {runner_uuid} on {repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a repository runner
      effect: destructive
      questions:
      - How do I unregister a self-hosted runner from a repository?
      - Can I delete a repo runner that is no longer in use?
      instructions:
      - text: Delete repository runner {runner_uuid} from {workspace}/{repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Unregister runner {runner_uuid} from repo {repo_slug}.
        slots:
          runner_uuid: path.runner_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline run
      effect: read
      questions:
      - What is the status and duration of a specific pipeline run?
      - Can I see who triggered a pipeline and how many build seconds it used?
      instructions:
      - text: Get pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the state of pipeline run {pipeline_uuid} for repo {repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the steps of a pipeline run
      effect: read
      questions:
      - Which steps did my pipeline run and which one failed?
      - Can I list every step in a pipeline with its status?
      instructions:
      - text: List the steps of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all steps for pipeline run {pipeline_uuid} in repo {repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one step of a pipeline run
      effect: read
      questions:
      - What happened in one particular step of my pipeline?
      - Can I see the timing and result of a single pipeline step?
      instructions:
      - text: Get step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show details for pipeline step {step_uuid} in run {pipeline_uuid} of repo {repo_slug}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the log for a pipeline step
      effect: read
      questions:
      - How do I fetch the build log for a failed pipeline step?
      - Can I read only part of a very large step log using a byte range?
      instructions:
      - text: Get the log for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Download the full step log for {step_uuid} in pipeline run {pipeline_uuid}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build or service container log
      effect: read
      questions:
      - How do I see the logs from a service container like a database running alongside my step?
      - Can I fetch the log of one specific container within a pipeline step?
      instructions:
      - text: Get container log {log_uuid} for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          log_uuid: path.log_uuid
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Fetch the service container log {log_uuid} from step {step_uuid}.
        slots:
          log_uuid: path.log_uuid
          step_uuid: path.step_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize test results for a pipeline step
      effect: read
      questions:
      - How many tests passed and failed in a pipeline step?
      - Can I get a test report summary for one step of my build?
      instructions:
      - text: Summarize the test reports for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the test results summary for pipeline step {step_uuid}.
        slots:
          step_uuid: path.step_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cases run in a pipeline step
      effect: read
      questions:
      - Which individual test cases ran in this pipeline step?
      - Can I list every test case and its outcome from a step's test report?
      instructions:
      - text: List the test cases for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show each test case executed in pipeline step {step_uuid}.
        slots:
          step_uuid: path.step_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the failure output for a test case
      effect: read
      questions:
      - Why did a specific test case fail in my pipeline?
      - Can I see the output and stack trace recorded for one test case?
      instructions:
      - text: Get the reasons for test case {test_case_uuid} in step {step_uuid} of pipeline {pipeline_uuid}, repo {workspace}/{repo_slug}.
        slots:
          test_case_uuid: path.test_case_uuid
          step_uuid: path.step_uuid
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the failure output for test case {test_case_uuid} in step {step_uuid}.
        slots:
          test_case_uuid: path.test_case_uuid
          step_uuid: path.step_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running pipeline
      effect: destructive
      questions:
      - How do I cancel a pipeline that is still running?
      - Does stopping a pipeline also halt its steps that haven't finished?
      instructions:
      - text: Stop pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Cancel the running pipeline {pipeline_uuid} on repo {repo_slug}.
        slots:
          pipeline_uuid: path.pipeline_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Pipelines is enabled on a repo
      effect: read
      questions:
      - Is Pipelines turned on for this repository?
      - Where can I view a repository's pipelines configuration settings?
      instructions:
      - text: Get the pipelines configuration for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Check if Pipelines is enabled on repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable Pipelines on a repo
      effect: write
      questions:
      - How do I turn on Bitbucket Pipelines for a repository through the API?
      - Can I disable Pipelines for a repo without deleting its configuration?
      instructions:
      - text: Set pipelines enabled to {enabled} for {workspace}/{repo_slug}.
        slots:
          enabled: requestBody.enabled
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Turn on Pipelines for repo {repo_slug} in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/build_number'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the next pipeline build number
      effect: write
      questions:
      - How do I bump the build number my next pipeline will get?
      - Can I reset the build counter to a lower number than the last build?
      instructions:
      - text: Set the next build number for {workspace}/{repo_slug} to {next}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          next: requestBody.next
      - text: Bump repo {repo_slug}'s pipeline build counter so the next build is {next}.
        slots:
          repo_slug: path.repo_slug
          next: requestBody.next
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled pipelines
      effect: read
      questions:
      - Which pipelines are scheduled to run on a timer in this repo?
      - Can I see all the cron schedules configured for my pipelines?
      instructions:
      - text: List pipeline schedules for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every scheduled pipeline configured on repo {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a pipeline to run on a cron
      effect: write
      questions:
      - How do I schedule a nightly pipeline run?
      - Can I set a cron pattern so a branch pipeline runs automatically?
      instructions:
      - text: Create a pipeline schedule in {workspace}/{repo_slug} for target {target} with cron {cron_pattern}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          target: requestBody.target
          cron_pattern: requestBody.cron_pattern
      - text: Schedule the pipeline for {target} on repo {repo_slug} to run on {cron_pattern}.
        slots:
          target: requestBody.target
          repo_slug: path.repo_slug
          cron_pattern: requestBody.cron_pattern
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline schedule
      effect: read
      questions:
      - What cron pattern and target does one of my pipeline schedules use?
      - Can I check whether a particular schedule is currently enabled?
      instructions:
      - text: Get pipeline schedule {schedule_uuid} in {workspace}/{repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the settings of schedule {schedule_uuid} on repo {repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause or resume a pipeline schedule
      effect: write
      questions:
      - How do I temporarily pause a scheduled pipeline without deleting it?
      - Can I re-enable a pipeline schedule I turned off?
      instructions:
      - text: Set schedule {schedule_uuid} in {workspace}/{repo_slug} to enabled {enabled}.
        slots:
          schedule_uuid: path.schedule_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
          enabled: requestBody.enabled
      - text: Pause the pipeline schedule {schedule_uuid} on repo {repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline schedule
      effect: destructive
      questions:
      - How do I permanently remove a scheduled pipeline?
      - Can I delete a cron schedule that I no longer need?
      instructions:
      - text: Delete pipeline schedule {schedule_uuid} from {workspace}/{repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the schedule {schedule_uuid} on repo {repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs triggered by a schedule
      effect: read
      questions:
      - Did my nightly scheduled pipeline actually run last night?
      - Can I see the history of executions for one pipeline schedule?
      instructions:
      - text: List executions of schedule {schedule_uuid} in {workspace}/{repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the run history for pipeline schedule {schedule_uuid} on repo {repo_slug}.
        slots:
          schedule_uuid: path.schedule_uuid
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the pipelines SSH public key
      effect: read
      questions:
      - What public key do my pipelines use when connecting over SSH?
      - Can I retrieve the repo's pipelines SSH key without exposing the private key?
      instructions:
      - text: Get the pipelines SSH key pair for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the public SSH key configured for pipelines on repo {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the SSH key pair used by pipelines
      effect: write
      questions:
      - How do I give my build container an SSH identity to reach a private server?
      - Can I replace the SSH key pair my pipelines use?
      instructions:
      - text: Set the pipelines SSH key pair for {workspace}/{repo_slug} with private key {private_key} and public key {public_key}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          private_key: requestBody.private_key
          public_key: requestBody.public_key
      - text: Upload public key {public_key} and its private key {private_key} as the build SSH identity for repo {repo_slug}.
        slots:
          public_key: requestBody.public_key
          private_key: requestBody.private_key
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the pipelines SSH key pair
      effect: destructive
      questions:
      - How do I remove the SSH key my pipelines use?
      - Can I revoke a repo's pipeline SSH identity if the key was leaked?
      instructions:
      - text: Delete the pipelines SSH key pair from {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the build SSH key pair on repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List pipeline SSH known hosts
      effect: read
      questions:
      - Which hosts have I added as trusted known hosts for pipeline SSH?
      - Can I see the host fingerprints my builds trust?
      instructions:
      - text: List the pipelines known hosts for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all trusted SSH known hosts on repo {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/overlays/bitbucket-pipelines-api-phrasing-overlay.yaml