Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness GnuPGP Keys API

4 actions 4 updates phrasing extends openapi/harness-gnupgp-keys-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys'].post

$.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}'].get

$.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness GnuPGP Keys API
  version: 1.0.0
extends: openapi/harness-gnupgp-keys-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: 3
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add GPG public keys to a GitOps agent
      effect: write
      questions:
      - How do I add a GPG public key so my GitOps agent can verify signed commits?
      - Can I upsert a key that's already configured on the agent?
      instructions:
      - text: Add GPG public key {publickey} to GitOps agent {agentIdentifier}.
        slots:
          publickey: requestBody.publickey
          agentIdentifier: path.agentIdentifier
      - text: Upsert a GPG key on agent {agentIdentifier} with upsert {upsert}.
        slots:
          agentIdentifier: path.agentIdentifier
          upsert: requestBody.upsert
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GPG public key on a GitOps agent
      effect: read
      questions:
      - What information does the agent hold about a specific GPG key?
      - Can I check whether a GPG key ID is configured on my GitOps agent?
      instructions:
      - text: Get GPG key {keyID} from GitOps agent {agentIdentifier}.
        slots:
          keyID: path.query.keyID
          agentIdentifier: path.agentIdentifier
      - text: Show the details of GPG key {keyID} on agent {agentIdentifier}.
        slots:
          keyID: path.query.keyID
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a GPG public key from a GitOps agent
      effect: destructive
      questions:
      - How do I remove a GPG key from my GitOps agent's configuration?
      - Can I revoke trust in a signing key on the agent?
      instructions:
      - text: Delete GPG key {keyID} from GitOps agent {agentIdentifier}.
        slots:
          keyID: path.query.keyID
          agentIdentifier: path.agentIdentifier
      - text: Remove signing key {keyID} from agent {agentIdentifier}.
        slots:
          keyID: path.query.keyID
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'