Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Gitx Webhooks API

6 actions 6 updates phrasing extends openapi/harness-org-gitx-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 6

$.info

$.paths['/v1/orgs/{org}/gitx-webhooks'].get

$.paths['/v1/orgs/{org}/gitx-webhooks'].post

$.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].get

$.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].put

$.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].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 Org Gitx Webhooks API
  version: 1.0.0
extends: openapi/harness-org-gitx-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: 5
- target: $.paths['/v1/orgs/{org}/gitx-webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List org-level GitX webhooks
      effect: read
      questions:
      - Which GitX webhooks are configured at the organization level?
      - Can I page through an org's GitX webhooks?
      instructions:
      - text: List GitX webhooks in org {org}.
        slots:
          org: path.org
      - text: Show org {org} GitX webhooks filtered to {webhook}.
        slots:
          org: path.org
          webhook: query.webhook_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/gitx-webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an org-level GitX webhook
      effect: write
      questions:
      - How do I set up a GitX webhook so Harness picks up changes from a Git repo for my org?
      - Can I limit an org GitX webhook to specific folder paths?
      instructions:
      - text: Create a GitX webhook {name} in org {org} for repo {repo} via connector {connector}.
        slots:
          name: requestBody.webhook_name
          org: path.org
          repo: requestBody.repo_name
          connector: requestBody.connector_ref
      - text: Add an org {org} GitX webhook watching folders {folders} in {repo}.
        slots:
          org: path.org
          folders: requestBody.folder_paths
          repo: requestBody.repo_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org-level GitX webhook
      effect: read
      questions:
      - What repo and folders does a particular org GitX webhook watch?
      - Can I fetch one GitX webhook's configuration at the org level?
      instructions:
      - text: Get GitX webhook {webhook} in org {org}.
        slots:
          webhook: path.gitx-webhook
          org: path.org
      - text: Show the configuration of org {org} webhook {webhook}.
        slots:
          org: path.org
          webhook: path.gitx-webhook
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an org-level GitX webhook
      effect: write
      questions:
      - How do I disable an org GitX webhook without deleting it?
      - Can I change the folders an existing GitX webhook watches?
      instructions:
      - text: Set enabled to {enabled} on GitX webhook {webhook} in org {org}.
        slots:
          enabled: requestBody.is_enabled
          webhook: path.gitx-webhook
          org: path.org
      - text: Change the folder paths of org {org} webhook {webhook} to {folders}.
        slots:
          org: path.org
          webhook: path.gitx-webhook
          folders: requestBody.folder_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/gitx-webhooks/{gitx-webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org-level GitX webhook
      effect: destructive
      questions:
      - How do I remove a GitX webhook from my organization?
      - Can I delete an org GitX webhook I no longer use?
      instructions:
      - text: Delete GitX webhook {webhook} from org {org}.
        slots:
          webhook: path.gitx-webhook
          org: path.org
      - text: Remove the org {org} webhook {webhook}.
        slots:
          org: path.org
          webhook: path.gitx-webhook
      method: generated
      generated: '2026-09-26'