# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Software Cloud Builds API
  version: 1.0.0
extends: openapi/jira-builds-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: 4
- target: $.paths['/rest/builds/0.1/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send CI build results to Jira
      effect: write
      questions:
      - How do I show my CI pipeline's build results on the related Jira issues?
      - What identifies a build so a newer submission replaces the old one?
      instructions:
      - text: Submit builds {builds} to Jira.
        slots:
          builds: requestBody.builds
      - text: Send build data {builds} tagged with properties {properties}.
        slots:
          builds: requestBody.builds
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/builds/0.1/bulkByProperties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete builds matching tagged properties
      effect: destructive
      questions:
      - Can I delete every build I submitted that carries a certain property?
      - If I pass several properties when deleting builds, must a build match all of them?
      instructions:
      - text: Delete all builds tagged with the properties I give you.
      - text: Bulk remove build data matching every one of these properties.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build by pipeline and build number
      effect: read
      questions:
      - What build data does Jira currently store for a given pipeline run?
      - Can I confirm a build submission landed in Jira?
      instructions:
      - text: Get build {buildNumber} of pipeline {pipelineId}.
        slots:
          buildNumber: path.buildNumber
          pipelineId: path.pipelineId
      - text: Show what Jira has stored for pipeline {pipelineId} build {buildNumber}.
        slots:
          pipelineId: path.pipelineId
          buildNumber: path.buildNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one build by pipeline and build number
      effect: destructive
      questions:
      - How do I remove a single build run from Jira?
      - Is deleting one build from Jira immediate?
      instructions:
      - text: Delete build {buildNumber} of pipeline {pipelineId}.
        slots:
          buildNumber: path.buildNumber
          pipelineId: path.pipelineId
      - text: Remove the stored data for pipeline {pipelineId} run {buildNumber}.
        slots:
          pipelineId: path.pipelineId
          buildNumber: path.buildNumber
      method: generated
      generated: '2026-09-26'