Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Git Full Sync API

6 actions 6 updates phrasing extends openapi/harness-git-full-sync-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['/ng/api/git-full-sync/config'].get
$.paths['/ng/api/git-full-sync/config'].put
$.paths['/ng/api/git-full-sync/config'].post
$.paths['/ng/api/git-full-sync/files'].post
$.paths['/ng/api/git-full-sync'].post

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 Git Full Sync API
  version: 1.0.0
extends: openapi/harness-git-full-sync-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['/ng/api/git-full-sync/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Git full sync configuration
      effect: read
      questions:
      - Which repo and branch is full Git sync configured to use?
      - Can I see the full sync settings for a specific project?
      instructions:
      - text: Show the Git full sync configuration for my account.
      - text: Get the full sync config for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/git-full-sync/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the Git full sync configuration
      effect: write
      questions:
      - How do I change the branch or folder full sync writes to?
      - Can full sync open a pull request against a target branch?
      instructions:
      - text: Change full sync to repo {repoIdentifier}, branch {branch}, folder {rootFolder}.
        slots:
          repoIdentifier: requestBody.repoIdentifier
          branch: requestBody.branch
          rootFolder: requestBody.rootFolder
      - text: Update full sync on {repoIdentifier} branch {branch} under {rootFolder} to open a PR into {targetBranch}.
        slots:
          repoIdentifier: requestBody.repoIdentifier
          branch: requestBody.branch
          rootFolder: requestBody.rootFolder
          targetBranch: requestBody.targetBranch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/git-full-sync/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up Git full sync for a scope
      effect: write
      questions:
      - How do I set up full sync of Harness entities to a Git repo for the first time?
      - Can the initial full sync go to a new branch cut from a base branch?
      instructions:
      - text: Configure full sync to repo {repoIdentifier} on branch {branch} in folder {rootFolder}.
        slots:
          repoIdentifier: requestBody.repoIdentifier
          branch: requestBody.branch
          rootFolder: requestBody.rootFolder
      - text: Create a full sync config for project {projectIdentifier} into {repoIdentifier}/{rootFolder} on new branch {branch} from {baseBranch}.
        slots:
          projectIdentifier: query.projectIdentifier
          repoIdentifier: requestBody.repoIdentifier
          rootFolder: requestBody.rootFolder
          branch: requestBody.branch
          baseBranch: requestBody.baseBranch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/git-full-sync/files'].post
  update:
    x-apievangelist-phrasing:
      intent: List files in a Git full sync with status
      effect: read
      questions:
      - Which files failed during the last full Git sync?
      - Can I filter full sync files by entity type or sync status?
      instructions:
      - text: List full sync files with sync status {syncStatus}.
        slots:
          syncStatus: requestBody.syncStatus
      - text: Show full sync files for entity types {entityTypes}.
        slots:
          entityTypes: requestBody.entityTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/git-full-sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Git full sync
      effect: write
      questions:
      - How do I kick off a full sync of my entities to Git?
      - Can I trigger full sync for just one project?
      instructions:
      - text: Trigger a Git full sync now.
      - text: Start full sync for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'