Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project mappings API

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

$.info

$.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].get

$.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].put

$.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].post

$.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping/{name}'].delete

$.paths['/gitops/api/v1/appprojectsmapping'].get

$.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping'].post

$.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].get

$.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].put

$.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].delete

$.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmappings'].get

$.paths['/gitops/api/v2/appprojectsmapping'].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 Project mappings API
  version: 1.0.0
extends: openapi/harness-project-mappings-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: 11
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List an agent's Argo project mappings (v1)
      effect: read
      questions:
      - Which Argo projects are mapped to Harness projects on a given GitOps agent?
      - Can I see the v1 project mapping list for one agent?
      instructions:
      - text: List Argo project mappings for GitOps agent {agent} using the v1 API.
        slots:
          agent: path.agentIdentifier
      - text: Show v1 Harness-Argo mappings on agent {agent}.
        slots:
          agent: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agent's Argo project mappings (v1)
      effect: write
      questions:
      - How do I change which Harness project an Argo project maps to on an agent, using v1?
      - Can I replace an agent's project mapping table in one v1 call?
      instructions:
      - text: Update the v1 project mappings on agent {agent} to {mapping}.
        slots:
          agent: path.agentIdentifier
          mapping: requestBody.appProjMap
      - text: Replace agent {agent}'s Argo-to-Harness mapping table with {mapping} via v1.
        slots:
          agent: path.agentIdentifier
          mapping: requestBody.appProjMap
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping'].post
  update:
    x-apievangelist-phrasing:
      intent: Create Argo project mappings on an agent (v1)
      effect: write
      questions:
      - Is there a v1 way to add new Argo project mappings for an agent?
      - Can I map several Argo projects to Harness in a single v1 create request?
      instructions:
      - text: Create v1 Argo project mappings {mapping} on agent {agent}.
        slots:
          agent: path.agentIdentifier
          mapping: requestBody.appProjMap
      - text: Map Argo projects to Harness on agent {agent} using the v1 create endpoint.
        slots:
          agent: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Argo project mapping by name (v1)
      effect: destructive
      questions:
      - How do I remove an Argo project mapping by its name on an agent?
      - Can I unmap one Argo project with the v1 API?
      instructions:
      - text: Delete the v1 project mapping named {name} on agent {agent}.
        slots:
          name: path.name
          agent: path.agentIdentifier
      - text: Unmap Argo project mapping {name} from agent {agent}.
        slots:
          name: path.name
          agent: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/appprojectsmapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List Argo project mappings across agents (v1)
      effect: read
      questions:
      - Can I list all Harness-Argo project mappings in my project regardless of agent?
      - Which Argo project mappings exist account-wide in the v1 API?
      instructions:
      - text: List all v1 Argo project mappings in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show every Harness-Argo project mapping, optionally narrowed to agent {agent}.
        slots:
          agent: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Argo project mapping (v2)
      effect: write
      questions:
      - Can a v2 mapping auto-create services and environments for me?
      - How do I map one Argo project to a Harness project with the v2 API?
      instructions:
      - text: Map Argo project {argo_project} on agent {agent} to Harness project {project} using v2.
        slots:
          argo_project: requestBody.argoProjectName
          agent: path.agentIdentifier
          project: requestBody.projectIdentifier
      - text: Create a v2 mapping for {argo_project} on agent {agent} with auto-create services set to {auto_create}.
        slots:
          argo_project: requestBody.argoProjectName
          agent: path.agentIdentifier
          auto_create: requestBody.autoCreateServiceEnv
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Argo project mapping by id (v2)
      effect: read
      questions:
      - Can I look up a single v2 project mapping by its identifier?
      - Which Argo project does a particular v2 mapping point to?
      instructions:
      - text: Get v2 project mapping {mapping_id} on agent {agent}.
        slots:
          mapping_id: path.identifier
          agent: path.agentIdentifier
      - text: Show details of mapping {mapping_id}.
        slots:
          mapping_id: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Argo project mapping (v2)
      effect: write
      questions:
      - What's the way to change the Argo project name on an existing v2 mapping?
      - Can I turn off auto-creation of services and environments on a mapping?
      instructions:
      - text: Update v2 mapping {mapping_id} on agent {agent} to Argo project {argo_project}.
        slots:
          mapping_id: path.identifier
          agent: path.agentIdentifier
          argo_project: requestBody.argoProjectName
      - text: Set auto-create services to {auto_create} on mapping {mapping_id}.
        slots:
          auto_create: requestBody.autoCreateServiceEnv
          mapping_id: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Argo project mapping by id (v2)
      effect: destructive
      questions:
      - How do I delete a v2 project mapping using its identifier?
      - Can I remove a mapping by id rather than by Argo project name?
      instructions:
      - text: Delete v2 project mapping {mapping_id} on agent {agent}.
        slots:
          mapping_id: path.identifier
          agent: path.agentIdentifier
      - text: Remove mapping {mapping_id} for Argo project {argo_project}.
        slots:
          mapping_id: path.identifier
          argo_project: query.argoProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/agents/{agentIdentifier}/appprojectsmappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List an agent's Argo project mappings (v2)
      effect: read
      questions:
      - Can I list v2 project mappings on one agent filtered by Argo project name?
      - Which mappings on this agent have auto-create services enabled?
      instructions:
      - text: List v2 project mappings on agent {agent}.
        slots:
          agent: path.agentIdentifier
      - text: Show agent {agent}'s v2 mappings for Argo project {argo_project}.
        slots:
          agent: path.agentIdentifier
          argo_project: query.argoProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v2/appprojectsmapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Argo project mappings with paging
      effect: read
      questions:
      - Can I search project mappings by keyword and page through the results?
      - Is there a paginated way to browse every Harness-Argo project mapping?
      instructions:
      - text: Search Argo project mappings for {term}.
        slots:
          term: query.searchTerm
      - text: List page {page} of project mappings with {page_size} per page.
        slots:
          page: query.pageIndex
          page_size: query.pageSize
      method: generated
      generated: '2026-09-26'