Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Collections API

5 actions 5 updates phrasing extends openapi/harness-collections-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 5

$.info
$.paths['/v1/org/units/list'].post
$.paths['/v1/org/units'].put
$.paths['/v1/org/units'].post
$.paths['/v1/org/units'].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 Collections API
  version: 1.0.0
extends: openapi/harness-collections-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: 4
- target: $.paths['/v1/org/units/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List collections
      effect: read
      questions:
      - Which collections (org units) are defined for my engineering insights?
      - Can I page through collections with a filter?
      instructions:
      - text: List my collections.
      - text: Show page {page} of collections matching filter {filter}.
        slots:
          page: requestBody.page
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/units'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing collection
      effect: write
      questions:
      - Can I change the definition of a collection that already exists?
      - How do I modify the members of an existing org unit collection?
      instructions:
      - text: Edit an existing collection with these changes.
      - text: Save updates to my current collection.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/units'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new collection
      effect: write
      questions:
      - How do I group teams or repositories into a new collection?
      - What does it take to add a new org unit collection?
      instructions:
      - text: Create a new collection.
      - text: Add a new org unit collection for my team.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/units'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection
      effect: destructive
      questions:
      - How do I remove a collection I no longer need?
      - Can I delete an org unit collection permanently?
      instructions:
      - text: Delete an existing collection.
      - text: Remove the org unit collection I specify.
      method: generated
      generated: '2026-09-26'