Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Project API

6 actions 6 updates phrasing extends openapi/harness-org-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 6

$.info

$.paths['/v1/orgs/{org}/projects'].get

$.paths['/v1/orgs/{org}/projects'].post

$.paths['/v1/orgs/{org}/projects/{project}'].get

$.paths['/v1/orgs/{org}/projects/{project}'].put

$.paths['/v1/orgs/{org}/projects/{project}'].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 Org Project API
  version: 1.0.0
extends: openapi/harness-org-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: 5
- target: $.paths['/v1/orgs/{org}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects in an organization
      effect: read
      questions:
      - Which projects exist in a given organization?
      - Can I list only projects that have a particular module enabled?
      - Is there a way to show just my favorite projects in an org?
      instructions:
      - text: List projects in organization {org}.
        slots:
          org: path.org
      - text: Find projects in org {org} matching {term}.
        slots:
          org: path.org
          term: query.search_term
      - text: Show projects in org {org} that use module {module}.
        slots:
          org: path.org
          module: query.module_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project in an organization
      effect: write
      questions:
      - How do I create a new project under an organization?
      - What's needed to add a project to an org?
      instructions:
      - text: Create project {project} in organization {org}.
        slots:
          project: requestBody.project
          org: path.org
      - text: Add a new project to org {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project
      effect: read
      questions:
      - Where can I see the details of one project?
      - Which modules and color are set on a given project?
      instructions:
      - text: Get project {project} in organization {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show details of project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project
      effect: write
      questions:
      - Can I rename a project or change its description?
      - How do I update the modules on an existing project?
      instructions:
      - text: Update project {project} in organization {org}.
        slots:
          project: path.project
          org: path.org
      - text: Rename project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project
      effect: destructive
      questions:
      - How do I delete a project from an organization?
      - What happens to a project's pipelines when the project is deleted?
      instructions:
      - text: Delete project {project} in organization {org}.
        slots:
          project: path.project
          org: path.org
      - text: Remove project {project} from org {org}.
        slots:
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'