Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Organization API

11 actions 11 updates phrasing extends openapi/harness-organization-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 11

$.info
$.paths['/v1/orgs'].get
$.paths['/v1/orgs'].post
$.paths['/v1/orgs/{org}'].get
$.paths['/v1/orgs/{org}'].put
$.paths['/v1/orgs/{org}'].delete
$.paths['/ng/api/organizations'].get
$.paths['/ng/api/organizations'].post
$.paths['/ng/api/organizations/{identifier}'].get
$.paths['/ng/api/organizations/{identifier}'].put
$.paths['/ng/api/organizations/{identifier}'].delete

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 Organization API
  version: 1.0.0
extends: openapi/harness-organization-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: 10
- target: $.paths['/v1/orgs'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations (v1)
      effect: read
      questions:
      - Which organizations exist in my Harness account?
      - Can I search organizations by name in the v1 orgs API?
      instructions:
      - text: List organizations matching {term}.
        slots:
          term: query.search_term
      - text: Show every organization in my account using the v1 endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization (v1)
      effect: write
      questions:
      - How do I create a new organization in Harness?
      - What's required to add an organization through the beta v1 API?
      instructions:
      - text: Create organization {org} with the v1 API.
        slots:
          org: requestBody.org
      - text: Add a new org {org} to my account.
        slots:
          org: requestBody.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization (v1)
      effect: read
      questions:
      - Where can I see one organization's details by its identifier?
      - What name and description does a given org have?
      instructions:
      - text: Get organization {org}.
        slots:
          org: path.org
      - text: Show details for org {org} from the v1 orgs endpoint.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization (v1)
      effect: write
      questions:
      - Can I rename an organization or change its description?
      - Which endpoint updates an org in the v1 API?
      instructions:
      - text: Update organization {org} with these details.
        slots:
          org: path.org
      - text: Rename org {org} via the v1 API.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization (v1)
      effect: destructive
      questions:
      - How do I delete an organization I no longer need?
      - What happens to an org when it's deleted through the v1 API?
      instructions:
      - text: Delete organization {org}.
        slots:
          org: path.org
      - text: Remove org {org} using the v1 endpoint.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations by filter (NG)
      effect: read
      questions:
      - Can I filter organizations by a list of identifiers?
      - Is there a paginated org list with a page token in the older NG API?
      instructions:
      - text: List organizations with identifiers {ids}.
        slots:
          ids: query.identifiers
      - text: Filter organizations by search term {term} using the NG API.
        slots:
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization (NG)
      effect: write
      questions:
      - Is there a legacy NG endpoint for creating an organization?
      - Can I create an org through the /ng/api organizations resource?
      instructions:
      - text: Create organization {organization} through the NG API.
        slots:
          organization: requestBody.organization
      - text: Post a new NG organization {organization}.
        slots:
          organization: requestBody.organization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/organizations/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details (NG)
      effect: read
      questions:
      - Can I fetch an organization by identifier from the NG API?
      - What does the NG endpoint return for one organization?
      instructions:
      - text: Get NG organization {identifier}.
        slots:
          identifier: path.identifier
      - text: Show organization {identifier} details from the NG API.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/organizations/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization (NG)
      effect: write
      questions:
      - Can I update an organization with an If-Match version check?
      - Which NG endpoint changes an organization's settings?
      instructions:
      - text: Update NG organization {identifier} settings.
        slots:
          identifier: path.identifier
      - text: Update organization {identifier} only if its version matches {etag}.
        slots:
          identifier: path.identifier
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/organizations/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization (NG)
      effect: destructive
      questions:
      - Can I delete an organization through the NG API?
      - Is there an optimistic-lock check when deleting an org?
      instructions:
      - text: Delete NG organization {identifier}.
        slots:
          identifier: path.identifier
      - text: Delete organization {identifier} if its version is {etag}.
        slots:
          identifier: path.identifier
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'