# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue redaction API
  version: 1.0.0
extends: openapi/jira-issue-redaction-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: 2
- target: $.paths['/rest/api/3/redact'].post
  update:
    x-apievangelist-phrasing:
      intent: Redact sensitive data in issue fields
      effect: destructive
      questions:
      - How do I permanently redact sensitive text from issue fields?
      - Is issue redaction done in the background as a job?
      instructions:
      - text: Redact the issue field data described in {redactions}.
        slots:
          redactions: requestBody.redactions
      - text: Submit a redaction job for {redactions}.
        slots:
          redactions: requestBody.redactions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/redact/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a redaction job's status
      effect: read
      questions:
      - Has my redaction job finished yet?
      - What statuses can a redaction job report?
      instructions:
      - text: Check the status of redaction job {jobId}.
        slots:
          jobId: path.jobId
      - text: Tell me whether redaction {jobId} completed.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'