Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Chaos Recommendations API

9 actions 9 updates phrasing extends openapi/harness-chaos-recommendations-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 9

$.info
$.paths['/gateway/chaos/manager/api/rest/recommendations'].get
$.paths['/gateway/chaos/manager/api/rest/recommendations'].post
$.paths['/gateway/chaos/manager/api/rest/recommendations'].delete
$.paths['/gateway/chaos/manager/api/rest/recommendations/action/create'].post
$.paths['/gateway/chaos/manager/api/rest/recommendations/action/pipeline'].post
$.paths['/gateway/chaos/manager/api/rest/recommendations/action/run'].post
$.paths['/gateway/chaos/manager/api/rest/recommendations/status'].put
$.paths['/gateway/chaos/manager/api/rest/recommendations/status'].post

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 Chaos Recommendations API
  version: 1.0.0
extends: openapi/harness-chaos-recommendations-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: 8
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chaos experiment recommendation
      effect: read
      questions:
      - What does a specific chaos recommendation suggest testing?
      - Can I read the details of one chaos recommendation by its ID?
      instructions:
      - text: Get chaos recommendation {rec}.
        slots:
          rec: query.recommendationID
      - text: Show recommendation {rec} in project {project}.
        slots:
          rec: query.recommendationID
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations'].post
  update:
    x-apievangelist-phrasing:
      intent: List chaos experiment recommendations
      effect: read
      questions:
      - Which chaos experiments are recommended for my project?
      - Can I filter chaos recommendations and page through them?
      instructions:
      - text: List chaos recommendations in project {project}, page {page} of size {limit}.
        slots:
          project: query.projectIdentifier
          page: query.page
          limit: query.limit
      - text: List chaos recommendations matching filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chaos recommendation
      effect: destructive
      questions:
      - Can I remove a chaos recommendation I don't want?
      - What happens when I delete a chaos recommendation?
      instructions:
      - text: Delete chaos recommendation {rec}.
        slots:
          rec: query.recommendationID
      - text: Remove recommendation {rec} from project {project}.
        slots:
          rec: query.recommendationID
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations/action/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an experiment from a recommendation
      effect: write
      questions:
      - Can I turn a chaos recommendation into a real experiment?
      - What gets created when I accept a recommended chaos experiment?
      instructions:
      - text: Create an experiment from recommendation {rec}.
        slots:
          rec: query.recommendationID
      - text: Build a new chaos experiment based on recommendation {rec} in project {project}.
        slots:
          rec: query.recommendationID
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations/action/pipeline'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a recommended experiment to a pipeline
      effect: write
      questions:
      - Can I add a recommended chaos experiment to my pipeline?
      - Is there a way to put a suggested experiment into a pipeline directly?
      instructions:
      - text: Add the experiment from recommendation {rec} to a pipeline.
        slots:
          rec: query.recommendationID
      - text: Insert recommended experiment {rec} into the pipeline for project {project}.
        slots:
          rec: query.recommendationID
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations/action/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a recommended chaos experiment
      effect: write
      questions:
      - Can I run a recommended chaos experiment right away?
      - What happens when I execute a recommendation instead of saving it?
      instructions:
      - text: Run the experiment recommended by {rec}.
        slots:
          rec: query.recommendationID
      - text: Execute recommendation {rec} now in project {project}.
        slots:
          rec: query.recommendationID
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a chaos recommendation's status
      effect: write
      questions:
      - Can I change the status of a single chaos recommendation?
      - How can I mark one recommendation as dismissed or done?
      instructions:
      - text: Set the status of recommendation {rec} to {status}.
        slots:
          rec: query.recommendationID
          status: query.status
      - text: Change chaos recommendation {rec} status to {status}.
        slots:
          rec: query.recommendationID
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/recommendations/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update chaos recommendation statuses
      effect: write
      questions:
      - Can I update the status of many chaos recommendations at once?
      - Is there a bulk way to change recommendation statuses in a project?
      instructions:
      - text: Bulk set chaos recommendations to status {status}.
        slots:
          status: query.status
      - text: Update all selected recommendations in project {project} to {status}.
        slots:
          project: query.projectIdentifier
          status: query.status
      method: generated
      generated: '2026-09-26'