Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project API

7 actions 7 updates phrasing extends openapi/harness-project-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['/ng/api/projects'].get
$.paths['/ng/api/projects'].post
$.paths['/ng/api/projects/{identifier}'].get
$.paths['/ng/api/projects/{identifier}'].put
$.paths['/ng/api/projects/{identifier}'].delete
$.paths['/ng/api/projects/list'].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 Project API
  version: 1.0.0
extends: openapi/harness-project-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['/ng/api/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects I'm a member of
      effect: read
      questions:
      - Which Harness projects do I belong to in an org?
      - Can I list only my favorite projects?
      - What projects have a particular module enabled?
      instructions:
      - text: List my projects in org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      - text: List my projects that use module {moduleType}.
        slots:
          moduleType: query.moduleType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project
      effect: write
      questions:
      - How do I create a new project in an organization?
      - What details are needed to set up a project?
      instructions:
      - text: Create project {project} in org {orgIdentifier}.
        slots:
          project: requestBody.project
          orgIdentifier: query.orgIdentifier
      - text: Set up a new project with details {project}.
        slots:
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's details
      effect: read
      questions:
      - What are the details of a specific project?
      - Can I look up one project by its identifier?
      instructions:
      - text: Show project {identifier}.
        slots:
          identifier: path.identifier
      - text: Get project {identifier} in org {orgIdentifier}.
        slots:
          identifier: path.identifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project
      effect: write
      questions:
      - How do I change a project's name or description?
      - Can I guard a project update with its version number?
      instructions:
      - text: Update project {identifier} with {project}.
        slots:
          identifier: path.identifier
          project: requestBody.project
      - text: Update project {identifier} only if its version is {ifMatch}.
        slots:
          identifier: path.identifier
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project
      effect: destructive
      questions:
      - How do I delete a project?
      - Does deleting a project need its version number?
      instructions:
      - text: Delete project {identifier}.
        slots:
          identifier: path.identifier
      - text: Delete project {identifier} in org {orgIdentifier}.
        slots:
          identifier: path.identifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/projects/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List my projects across several orgs
      effect: read
      questions:
      - Can I list my projects from multiple organizations at once?
      - Which of my projects across orgs match a search word?
      instructions:
      - text: List my projects in orgs {orgIdentifiers}.
        slots:
          orgIdentifiers: query.orgIdentifiers
      - text: Search my projects across orgs {orgIdentifiers} for {searchTerm}.
        slots:
          orgIdentifiers: query.orgIdentifiers
          searchTerm: query.searchTerm
      method: generated
      generated: '2026-09-26'