Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness GitX Webhooks API

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

$.info

$.paths['/v1/gitx-webhooks'].get

$.paths['/v1/gitx-webhooks'].post

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

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

$.paths['/v1/gitx-webhooks/{gitx-webhook}'].delete

$.paths['/v1/gitx-webhook-events'].get

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 GitX Webhooks API
  version: 1.0.0
extends: openapi/harness-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: 6
- target: $.paths['/v1/gitx-webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level GitX webhooks
      effect: read
      questions:
      - Which GitX webhooks are configured at the account level?
      - Can I look up account GitX webhooks by identifier?
      instructions:
      - text: List the GitX webhooks in my account.
      - text: List account GitX webhooks filtered to {webhook_identifier}.
        slots:
          webhook_identifier: query.webhook_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gitx-webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level GitX webhook
      effect: write
      questions:
      - How do I set up a GitX webhook so Harness syncs entities from my Git repo?
      - Can I limit a GitX webhook to certain folder paths?
      instructions:
      - text: Create GitX webhook {webhook_name} for repo {repo_name} using connector {connector_ref}.
        slots:
          webhook_name: requestBody.webhook_name
          repo_name: requestBody.repo_name
          connector_ref: requestBody.connector_ref
      - text: Create an account GitX webhook on {repo_name} that watches folders {folder_paths}.
        slots:
          repo_name: requestBody.repo_name
          folder_paths: requestBody.folder_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gitx-webhooks/{gitx-webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level GitX webhook
      effect: read
      questions:
      - How do I see the repo and folders a GitX webhook is watching?
      - Is a particular GitX webhook enabled?
      instructions:
      - text: Get GitX webhook {gitx-webhook}.
        slots:
          gitx-webhook: path.gitx-webhook
      - text: Show the configuration of GitX webhook {gitx-webhook}.
        slots:
          gitx-webhook: path.gitx-webhook
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gitx-webhooks/{gitx-webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level GitX webhook
      effect: write
      questions:
      - Can I disable a GitX webhook without deleting it?
      - How do I change which folders a GitX webhook watches?
      instructions:
      - text: Set GitX webhook {gitx-webhook} to enabled={is_enabled}.
        slots:
          gitx-webhook: path.gitx-webhook
          is_enabled: requestBody.is_enabled
      - text: Change GitX webhook {gitx-webhook} to watch folders {folder_paths}.
        slots:
          gitx-webhook: path.gitx-webhook
          folder_paths: requestBody.folder_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gitx-webhooks/{gitx-webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level GitX webhook
      effect: destructive
      questions:
      - How do I remove a GitX webhook from my account?
      - Can I delete a GitX webhook I no longer need?
      instructions:
      - text: Delete GitX webhook {gitx-webhook}.
        slots:
          gitx-webhook: path.gitx-webhook
      - text: Remove the account GitX webhook {gitx-webhook}.
        slots:
          gitx-webhook: path.gitx-webhook
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/gitx-webhook-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level GitX webhook events
      effect: read
      questions:
      - What Git push events have my account's GitX webhooks received?
      - Can I filter GitX webhook events by repo, branch, commit or status?
      - How do I find failed GitX webhook events in a time range?
      instructions:
      - text: List account GitX webhook events for repo {repo_name} on branch {branch}.
        slots:
          repo_name: query.repo_name
          branch: query.branch
      - text: Show account GitX webhook events with status {event_status} since {event_start_time}.
        slots:
          event_status: query.event_status
          event_start_time: query.event_start_time
      - text: Find the account GitX webhook event for commit {commit_id}.
        slots:
          commit_id: query.commit_id
      method: generated
      generated: '2026-09-26'