Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Gitx Webhooks API

6 actions 6 updates phrasing extends openapi/harness-project-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}/projects/{project}/gitx-webhooks'].get

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

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

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

$.paths['/v1/orgs/{org}/projects/{project}/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 Project Gitx Webhooks API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/gitx-webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List GitX webhooks in a project
      effect: read
      questions:
      - Which GitX webhooks are configured for this project?
      - Can I look up project GitX webhooks by identifier?
      instructions:
      - text: List GitX webhooks in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show project GitX webhooks matching {webhook_identifier} in {org}/{project}.
        slots:
          webhook_identifier: query.webhook_identifier
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/gitx-webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project GitX webhook
      effect: write
      questions:
      - How do I set up a GitX webhook so Harness syncs changes from my repo?
      - Can a GitX webhook watch only certain folder paths?
      instructions:
      - text: Create GitX webhook {webhook_name} for repo {repo_name} in {org}/{project}.
        slots:
          webhook_name: requestBody.webhook_name
          repo_name: requestBody.repo_name
          org: path.org
          project: path.project
      - text: Add a project GitX webhook in {org}/{project} watching folders {folder_paths}.
        slots:
          org: path.org
          project: path.project
          folder_paths: requestBody.folder_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project GitX webhook
      effect: read
      questions:
      - What repo and folders does a specific GitX webhook track?
      - Is a particular project GitX webhook enabled?
      instructions:
      - text: Get GitX webhook {gitx-webhook} in {org}/{project}.
        slots:
          gitx-webhook: path.gitx-webhook
          org: path.org
          project: path.project
      - text: Show project {project} webhook {gitx-webhook} in org {org}.
        slots:
          project: path.project
          gitx-webhook: path.gitx-webhook
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project GitX webhook
      effect: write
      questions:
      - How do I disable a GitX webhook without deleting it?
      - Can I change the folder paths a GitX webhook watches?
      instructions:
      - text: Set enabled to {is_enabled} on GitX webhook {gitx-webhook} in {org}/{project}.
        slots:
          is_enabled: requestBody.is_enabled
          gitx-webhook: path.gitx-webhook
          org: path.org
          project: path.project
      - text: Change the watched folders of webhook {gitx-webhook} in project {project} of org {org} to {folder_paths}.
        slots:
          gitx-webhook: path.gitx-webhook
          project: path.project
          org: path.org
          folder_paths: requestBody.folder_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project GitX webhook
      effect: destructive
      questions:
      - How do I remove a GitX webhook from a project?
      - Can I delete a project webhook that stopped being useful?
      instructions:
      - text: Delete GitX webhook {gitx-webhook} from {org}/{project}.
        slots:
          gitx-webhook: path.gitx-webhook
          org: path.org
          project: path.project
      - text: Remove project webhook {gitx-webhook} in project {project} of org {org}.
        slots:
          gitx-webhook: path.gitx-webhook
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'