Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Collection categories API

6 actions 6 updates phrasing extends openapi/harness-collection-categories-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/org/workspaces/units/list'].post
$.paths['/v1/org/categories'].post
$.paths['/v1/org/categories'].delete
$.paths['/v1/org/categories/{id}'].put
$.paths['/v1/org/categories/{id}'].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 Collection categories API
  version: 1.0.0
extends: openapi/harness-collection-categories-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/org/workspaces/units/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List collection categories
      effect: read
      questions:
      - Which collection categories are defined for my SEI workspace?
      - Can I filter and page through collection categories?
      instructions:
      - text: List collection categories matching filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Show all my collection categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a collection category
      effect: write
      questions:
      - How do I add a new collection category to a workspace?
      - Can I create a category that starts out disabled?
      instructions:
      - text: Create a collection category named {name} in workspace {workspace}.
        slots:
          name: requestBody.name
          workspace: requestBody.workspaceId
      - text: Add category {name} described as {description} under root collection {root}.
        slots:
          name: requestBody.name
          description: requestBody.description
          root: requestBody.rootOuName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/categories'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several collection categories at once
      effect: destructive
      questions:
      - Can I delete multiple collection categories in a single request?
      - Is there a bulk delete for collection categories?
      instructions:
      - text: Bulk delete the selected collection categories.
      - text: Remove multiple collection categories in one request.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/categories/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a collection category
      effect: write
      questions:
      - How do I rename an existing collection category?
      - Can I disable a collection category without deleting it?
      instructions:
      - text: Rename collection category {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set enabled to {enabled} on collection category {id}.
        slots:
          enabled: requestBody.enabled
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one collection category
      effect: destructive
      questions:
      - How do I delete a single collection category by its ID?
      - What removes just one category rather than a batch?
      instructions:
      - text: Delete collection category {id}.
        slots:
          id: path.id
      - text: Remove only the category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'