Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Webhooks API

9 actions 9 updates phrasing extends openapi/harness-webhooks-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 9

$.info
$.paths['/har/api/v1/registry/{registry_ref}/webhooks'].get
$.paths['/har/api/v1/registry/{registry_ref}/webhooks'].post
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].get
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].put
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].delete
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions'].get
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get
$.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Webhooks API
  version: 1.0.0
extends: openapi/harness-webhooks-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: 8
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on an artifact registry
      effect: read
      questions:
      - Which webhooks are configured on my artifact registry?
      - Can I search a registry's webhooks by name?
      instructions:
      - text: List the webhooks on registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Find webhooks on registry {registry} matching {term}.
        slots:
          registry: path.registry_ref
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook on an artifact registry
      effect: write
      questions:
      - How do I get notified at my own URL when artifacts are pushed to a registry?
      - Can a registry webhook send extra headers or use a secret?
      instructions:
      - text: Create an enabled webhook {name} ({identifier}) on registry {registry} posting to {url}, TLS verification on.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          registry: path.registry_ref
          url: requestBody.url
      - text: Add webhook {identifier} named {name} to {registry} calling {url}, enabled {enabled}, insecure {insecure}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          registry: path.registry_ref
          url: requestBody.url
          enabled: requestBody.enabled
          insecure: requestBody.insecure
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry webhook
      effect: read
      questions:
      - What URL and triggers does a particular registry webhook use?
      - Is a given registry webhook enabled?
      instructions:
      - text: Show webhook {webhook} on registry {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      - text: Get the URL and triggers of webhook {webhook} in {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a registry webhook
      effect: write
      questions:
      - How do I change the target URL of an existing registry webhook?
      - Can I disable a registry webhook by editing it?
      instructions:
      - text: Point webhook {webhook} on {registry} at {url}, keeping name {name} and identifier {identifier}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
          url: requestBody.url
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Set enabled to {enabled} on existing webhook {webhook} in {registry}.
        slots:
          enabled: requestBody.enabled
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry webhook
      effect: destructive
      questions:
      - How do I stop a registry from calling a webhook for good?
      - Can I remove a webhook from an artifact registry?
      instructions:
      - text: Delete webhook {webhook} from registry {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      - text: Remove the {webhook} webhook on {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List delivery attempts of a registry webhook
      effect: read
      questions:
      - Did my registry webhook actually fire, and what did the endpoint respond?
      - Can I see the delivery history of a webhook?
      instructions:
      - text: List the executions of webhook {webhook} on registry {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      - text: Show recent deliveries for {webhook} in {registry}.
        slots:
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook delivery attempt
      effect: read
      questions:
      - What request and response were recorded for one webhook delivery?
      - Why did a specific webhook execution fail?
      instructions:
      - text: Show webhook execution {execution} for {webhook} on registry {registry}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          registry: path.registry_ref
      - text: Get the details of delivery {execution} of webhook {webhook} in {registry}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger'].get
  update:
    x-apievangelist-phrasing:
      intent: Retry a registry webhook delivery
      effect: write
      questions:
      - Can I resend a webhook delivery that failed while my endpoint was down?
      - How do I retrigger a past webhook execution?
      instructions:
      - text: Retrigger webhook execution {execution} of {webhook} on registry {registry}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          registry: path.registry_ref
      - text: Resend failed delivery {execution} for webhook {webhook} in {registry}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'