# 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 Deployments API
  version: 1.0.0
extends: openapi/jira-deployments-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['/rest/deployments/0.1/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send deployment data to Jira
      effect: write
      questions:
      - How do I report deployments from my CI/CD pipeline so they show on Jira issues?
      - Does submitting a deployment with the same pipeline, environment and sequence number overwrite it?
      instructions:
      - text: Submit deployments {deployments} to Jira.
        slots:
          deployments: requestBody.deployments
      - text: Send deployment data {deployments} with provider metadata {providerMetadata}.
        slots:
          deployments: requestBody.deployments
          providerMetadata: requestBody.providerMetadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/deployments/0.1/bulkByProperties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all deployments matching given properties
      effect: destructive
      questions:
      - Can I wipe every deployment tagged with a certain property?
      - Which deployments get removed when I bulk delete by property?
      instructions:
      - text: Delete all deployments that match the properties I pass as query parameters.
      - text: Bulk delete deployments by property using update sequence number {_updateSequenceNumber}.
        slots:
          _updateSequenceNumber: query._updateSequenceNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stored deployment by its key
      effect: read
      questions:
      - What deployment data does Jira currently hold for a pipeline run?
      - Can I read back a deployment I submitted using its pipeline, environment and sequence number?
      instructions:
      - text: Get deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
        slots:
          deploymentSequenceNumber: path.deploymentSequenceNumber
          environmentId: path.environmentId
          pipelineId: path.pipelineId
      - text: Show the stored data for pipeline {pipelineId}, environment {environmentId}, deployment {deploymentSequenceNumber}.
        slots:
          pipelineId: path.pipelineId
          environmentId: path.environmentId
          deploymentSequenceNumber: path.deploymentSequenceNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one deployment by its key
      effect: destructive
      questions:
      - How do I delete a single deployment record from Jira?
      - Is deleting a deployment by key immediate or asynchronous?
      instructions:
      - text: Delete deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
        slots:
          deploymentSequenceNumber: path.deploymentSequenceNumber
          environmentId: path.environmentId
          pipelineId: path.pipelineId
      - text: Remove the stored deployment for pipeline {pipelineId}, environment {environmentId}, sequence {deploymentSequenceNumber}.
        slots:
          pipelineId: path.pipelineId
          environmentId: path.environmentId
          deploymentSequenceNumber: path.deploymentSequenceNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a deployment's gating status
      effect: read
      questions:
      - Is my deployment currently gated or allowed to proceed?
      - Can my deployment provider app check the gating status of a deployment?
      instructions:
      - text: Get the gating status of deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
        slots:
          deploymentSequenceNumber: path.deploymentSequenceNumber
          environmentId: path.environmentId
          pipelineId: path.pipelineId
      - text: Check whether pipeline {pipelineId} deployment {deploymentSequenceNumber} to {environmentId} is gated.
        slots:
          pipelineId: path.pipelineId
          deploymentSequenceNumber: path.deploymentSequenceNumber
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'