# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Artifact Signing API
  version: 1.0.0
extends: openapi/harness-artifactsigning-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['/v1/orgs/{org}/projects/{project}/signing/{signatureId}/save-signature'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an artifact signature
      effect: write
      questions:
      - How do I save the signature produced when an artifact was signed in a pipeline?
      - Can I store the Rekor transparency log entry alongside an artifact signature?
      instructions:
      - text: Save signature {signature} for project {project} in org {org}.
        slots:
          signature: path.signatureId
          project: path.project
          org: path.org
      - text: Record signature {signature} for artifact {artifact} with Rekor entry {rekor} in {org}/{project}.
        slots:
          signature: path.signatureId
          artifact: requestBody.artifact
          rekor: requestBody.rekor
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/signing/{signatureId}/save-integrity-verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an artifact integrity verification
      effect: write
      questions:
      - Where do I record whether an artifact passed signature verification?
      - Can I save the error message when an artifact's integrity check fails?
      instructions:
      - text: Save integrity verification for signature {signature} in {org}/{project} with status {status}.
        slots:
          signature: path.signatureId
          org: path.org
          project: path.project
          status: requestBody.verification_status
      - text: Record a failed verification for signature {signature} in {org}/{project} with error {error}.
        slots:
          signature: path.signatureId
          org: path.org
          project: path.project
          error: requestBody.error_message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/signing/upload-signature'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an artifact signature
      effect: write
      questions:
      - How do I upload a signature and its signed payload for an artifact?
      - Can I push a detached signature into a project's signing store?
      instructions:
      - text: Upload signature {signature} with payload {payload} to {org}/{project}.
        slots:
          signature: requestBody.signature
          payload: requestBody.payload
          org: path.org
          project: path.project
      - text: Upload a signature to project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/signing/download-signature'].post
  update:
    x-apievangelist-phrasing:
      intent: Download an artifact's signature
      effect: read
      questions:
      - How do I fetch the signature for an image by its digest or tag?
      - Can I download the stored signature for an artifact in a given registry?
      instructions:
      - text: Download the signature for artifact {name} with digest {digest} in {org}/{project}.
        slots:
          name: requestBody.name
          digest: requestBody.digest
          org: path.org
          project: path.project
      - text: Get the signature of {name}:{tag} from registry {registry} in project {project} of org {org}.
        slots:
          name: requestBody.name
          tag: requestBody.tag
          registry: requestBody.registry_url
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'