# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Branch Sequences API
  version: 1.0.0
extends: openapi/harness-branch-sequences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/branch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset the build counter for one branch
      effect: destructive
      questions:
      - How do I reset the build number for just one branch of a pipeline?
      - Can I delete the sequence record for a single repo and branch?
      instructions:
      - text: Delete the branch sequence for branch {branch} of repo {repoUrl} on pipeline {pipelineIdentifier}.
        slots:
          branch: query.branch
          repoUrl: query.repoUrl
          pipelineIdentifier: path.pipelineIdentifier
      - text: Reset only the {branch} build counter on pipeline {pipelineIdentifier}.
        slots:
          branch: query.branch
          pipelineIdentifier: path.pipelineIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences'].get
  update:
    x-apievangelist-phrasing:
      intent: List build counters for every branch of a pipeline
      effect: read
      questions:
      - What is the current build number for each branch of my pipeline?
      - Can I see all branch and repo sequence records for a pipeline?
      instructions:
      - text: List branch sequences for pipeline {pipelineIdentifier}.
        slots:
          pipelineIdentifier: path.pipelineIdentifier
      - text: Show build counters for all branches of pipeline {pipelineIdentifier} in project {projectIdentifier}.
        slots:
          pipelineIdentifier: path.pipelineIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset build counters for all branches of a pipeline
      effect: destructive
      questions:
      - How do I wipe every branch build counter on a pipeline?
      - Can I reset build numbering for all branches at once?
      instructions:
      - text: Delete all branch sequences on pipeline {pipelineIdentifier}.
        slots:
          pipelineIdentifier: path.pipelineIdentifier
      - text: Reset every branch build counter for pipeline {pipelineIdentifier} in project {projectIdentifier}.
        slots:
          pipelineIdentifier: path.pipelineIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current build number for a branch
      effect: read
      questions:
      - What sequence ID is a specific branch of my pipeline on right now?
      - How do I read the build counter for one repo and branch?
      instructions:
      - text: Get the current sequence for branch {branch} of repo {repoUrl} on pipeline {pipelineIdentifier}.
        slots:
          branch: query.branch
          repoUrl: query.repoUrl
          pipelineIdentifier: path.pipelineIdentifier
      - text: Report the build number branch {branch} is currently at on pipeline {pipelineIdentifier}.
        slots:
          branch: query.branch
          pipelineIdentifier: path.pipelineIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/{pipelineIdentifier}/branch-sequences/set'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the build counter for a branch
      effect: write
      questions:
      - Can I set a branch's build number to a specific value?
      - Does setting a branch sequence create the record if it doesn't exist?
      instructions:
      - text: Set the sequence for branch {branch} of repo {repoUrl} on pipeline {pipelineIdentifier} to {sequenceId}.
        slots:
          branch: query.branch
          repoUrl: query.repoUrl
          pipelineIdentifier: path.pipelineIdentifier
          sequenceId: query.sequenceId
      - text: Start branch {branch} builds on pipeline {pipelineIdentifier} from number {sequenceId}.
        slots:
          branch: query.branch
          pipelineIdentifier: path.pipelineIdentifier
          sequenceId: query.sequenceId
      method: generated
      generated: '2026-09-26'