# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Console Release Pipelines API
  version: 1.0.0
extends: openapi/statsig-release-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: 13
- target: $.paths['/console/v1/release_pipeline_triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List release pipeline runs
      effect: read
      questions:
      - Which release pipeline rollouts are in progress right now?
      - Can I find pipeline triggers for a specific gate?
      - What pipeline runs started within a date range?
      instructions:
      - text: List triggers for release pipeline {releasePipelineID}.
        slots:
          releasePipelineID: query.releasePipelineID
      - text: Show {status} pipeline triggers on gate {gateID}.
        slots:
          status: query.status
          gateID: query.gateID
      - text: Find pipeline triggers created between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release pipeline run
      effect: read
      questions:
      - Which phase is a given rollout currently in?
      - What is the state of one pipeline trigger?
      instructions:
      - text: Show pipeline trigger {id}.
        slots:
          id: path.id
      - text: Get the current phase of rollout {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/abort'].put
  update:
    x-apievangelist-phrasing:
      intent: Abort a release pipeline run
      effect: destructive
      questions:
      - How do I stop a bad rollout immediately?
      - Can I abort a pipeline run partway through?
      instructions:
      - text: Abort pipeline trigger {id}.
        slots:
          id: path.id
      - text: Cancel the rollout {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/approve'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve the next pipeline phase
      effect: write
      questions:
      - How do I sign off on a rollout phase that needs approval?
      - Why must I pass the phase ID when approving?
      instructions:
      - text: Approve phase {phaseID} of pipeline trigger {id}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      - text: Sign off rollout {id} at phase {phaseID} so it can proceed.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/pause'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause a release pipeline run
      effect: write
      questions:
      - Can I hold a rollout at its current phase while we investigate?
      - Is pausing a pipeline run reversible?
      instructions:
      - text: Pause pipeline trigger {id} at phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      - text: Hold rollout {id} in phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/rollout'].put
  update:
    x-apievangelist-phrasing:
      intent: Fully roll out a pipeline run
      effect: write
      questions:
      - Can I skip the remaining phases and ship to everyone?
      - How do I complete a release pipeline right away?
      instructions:
      - text: Fully roll out pipeline trigger {id}.
        slots:
          id: path.id
      - text: Ship rollout {id} to 100 percent now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/skip'].put
  update:
    x-apievangelist-phrasing:
      intent: Skip to a pipeline phase
      effect: write
      questions:
      - Can I jump a rollout ahead to a later phase?
      - Is it possible to skip a waiting period in a release pipeline?
      instructions:
      - text: Skip pipeline trigger {id} to phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      - text: Jump rollout {id} ahead to phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipeline_triggers/{id}/unpause'].put
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused pipeline run
      effect: write
      questions:
      - How do I resume a rollout I paused?
      - Can a paused release pipeline pick up where it left off?
      instructions:
      - text: Unpause pipeline trigger {id} at phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      - text: Resume paused rollout {id} from phase {phaseID}.
        slots:
          id: path.id
          phaseID: requestBody.phaseID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List release pipelines
      effect: read
      questions:
      - What release pipeline templates have we defined?
      - Can I page through all release pipelines?
      instructions:
      - text: List all release pipelines.
      - text: Show release pipelines page {page}, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release pipeline
      effect: write
      questions:
      - How do I define a staged rollout that runs phase by phase?
      - Can I show a notice on configs that use a pipeline?
      instructions:
      - text: Create release pipeline {name} with phases {phases}.
        slots:
          name: requestBody.name
          phases: requestBody.phases
      - text: Create pipeline {name} that shows notice {triggerNotice} when triggered.
        slots:
          name: requestBody.name
          triggerNotice: requestBody.triggerNotice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipelines/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release pipeline
      effect: read
      questions:
      - What phases make up a particular release pipeline?
      - Can I read one pipeline's definition?
      instructions:
      - text: Show release pipeline {id}.
        slots:
          id: path.id
      - text: Get the phases of pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipelines/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a release pipeline
      effect: write
      questions:
      - How do I change the phases of an existing pipeline?
      - Can I rename a release pipeline?
      instructions:
      - text: Set the phases of pipeline {id} to {phases}.
        slots:
          id: path.id
          phases: requestBody.phases
      - text: Rename pipeline {id} to {name} and change its notice to {triggerNotice}.
        slots:
          id: path.id
          name: requestBody.name
          triggerNotice: requestBody.triggerNotice
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/release_pipelines/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release pipeline
      effect: destructive
      questions:
      - Can I delete a pipeline template we no longer use?
      - Is removing a release pipeline permanent?
      instructions:
      - text: Delete release pipeline {id}.
        slots:
          id: path.id
      - text: Remove the pipeline definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'