Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Projects API

7 actions 7 updates phrasing extends openapi/harness-projects-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['/gitops/api/v1/agents/{agentIdentifier}/projects'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/projects'].post
$.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}'].delete
$.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{request.project.metadata.name}'].put
$.paths['/ng/api/projects'].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 Projects API
  version: 1.0.0
extends: openapi/harness-projects-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['/gitops/api/v1/agents/{agentIdentifier}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List Argo CD projects on a GitOps agent
      effect: read
      questions:
      - Which Argo CD projects does a GitOps agent manage?
      - Can I filter an agent's Argo projects by name?
      instructions:
      - text: List Argo projects on GitOps agent {agentIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
      - text: List Argo projects named {query.name} on agent {agentIdentifier}.
        slots:
          query.name: query.query.name
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Argo CD project on a GitOps agent
      effect: write
      questions:
      - How do I create a new Argo CD project through a Harness GitOps agent?
      - Can I upsert an Argo project if it already exists?
      instructions:
      - text: Create Argo project {project} on GitOps agent {agentIdentifier}.
        slots:
          project: requestBody.project
          agentIdentifier: path.agentIdentifier
      - text: Create or update Argo project {project} on agent {agentIdentifier} with upsert={upsert}.
        slots:
          project: requestBody.project
          agentIdentifier: path.agentIdentifier
          upsert: requestBody.upsert
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Argo CD project by name
      effect: read
      questions:
      - How do I fetch one Argo project's definition from a GitOps agent?
      - What source repos and destinations does an Argo project allow?
      instructions:
      - text: Get Argo project {query.name} from GitOps agent {agentIdentifier}.
        slots:
          query.name: path.query.name
          agentIdentifier: path.agentIdentifier
      - text: Show the Argo project called {query.name}.
        slots:
          query.name: path.query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Argo CD project
      effect: destructive
      questions:
      - How do I delete an Argo CD project from a GitOps agent?
      - Can I remove an Argo project by name?
      instructions:
      - text: Delete Argo project {query.name} on GitOps agent {agentIdentifier}.
        slots:
          query.name: path.query.name
          agentIdentifier: path.agentIdentifier
      - text: Remove the Argo project {query.name}.
        slots:
          query.name: path.query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/projects/{request.project.metadata.name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Argo CD project
      effect: write
      questions:
      - How do I change an existing Argo project's allowed repos or destinations?
      - Can I edit an Argo project's spec through the GitOps agent?
      instructions:
      - text: Update Argo project {request.project.metadata.name} on GitOps agent {agentIdentifier}.
        slots:
          request.project.metadata.name: path.request.project.metadata.name
          agentIdentifier: path.agentIdentifier
      - text: Apply spec {project} to existing Argo project {request.project.metadata.name}.
        slots:
          project: requestBody.project
          request.project.metadata.name: path.request.project.metadata.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List Harness projects in an account
      effect: read
      questions:
      - Which Harness projects exist in my account?
      - Can I list only the projects in one organization?
      instructions:
      - text: List Harness projects in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: List the Harness projects in org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'