Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Folders API

5 actions 5 updates phrasing extends openapi/harness-folders-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['/dashboard/folders'].post
$.paths['/dashboard/folders/{folder_id}'].get
$.paths['/dashboard/folders/{folder_id}'].delete
$.paths['/dashboard/folders/{folder_id}'].patch

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 Folders API
  version: 1.0.0
extends: openapi/harness-folders-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['/dashboard/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard folder
      effect: write
      questions:
      - How do I create a folder to organise our custom dashboards?
      - Can I make a new dashboard folder with just a name?
      instructions:
      - text: Create a dashboard folder named {name}.
        slots:
          name: requestBody.name
      - text: Make a new folder {name} for our dashboards.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/folders/{folder_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard folder
      effect: read
      questions:
      - What are the details of a particular dashboard folder?
      - Can I look up a dashboard folder by its ID?
      instructions:
      - text: Get dashboard folder {folder}.
        slots:
          folder: path.folder_id
      - text: Show the details of folder {folder}.
        slots:
          folder: path.folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/folders/{folder_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard folder and its dashboards
      effect: destructive
      questions:
      - What happens to the dashboards inside a folder when I delete it?
      - How do I remove a dashboard folder entirely?
      instructions:
      - text: Delete folder {folder} and every dashboard in it.
        slots:
          folder: path.folder_id
      - text: Remove dashboard folder {folder}.
        slots:
          folder: path.folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/folders/{folder_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a dashboard folder
      effect: write
      questions:
      - How do I rename a dashboard folder?
      - Can I change a folder's name without moving its dashboards?
      instructions:
      - text: Rename folder {folder} to {name}.
        slots:
          folder: path.folder_id
          name: requestBody.name
      - text: Change the name of dashboard folder {folder} to {name}.
        slots:
          folder: path.folder_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'