Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Risks API

12 actions 12 updates phrasing extends openapi/harness-risks-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 12

$.info
$.paths['/gateway/chaos/manager/api/rest/service/experimentation/report/{accountID}'].get
$.paths['/gateway/chaos/manager/api/rest/service/overall/stats/{accountID}'].get
$.paths['/gateway/chaos/manager/api/rest/service/report/{accountID}'].get
$.paths['/gateway/chaos/manager/api/rest/service/stats/{accountID}'].get
$.paths['/gateway/chaos/manager/api/rest/service/{accountID}'].get
$.paths['/gateway/chaos/manager/api/v3/risks'].get
$.paths['/gateway/chaos/manager/api/v3/risks'].post
$.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].get
$.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].put
$.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].delete
$.paths['/gateway/chaos/manager/api/v3/risks/{identity}/active-risks'].get

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 Risks API
  version: 1.0.0
extends: openapi/harness-risks-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: 11
- target: $.paths['/gateway/chaos/manager/api/rest/service/experimentation/report/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a chaos experimentation activity report
      effect: read
      questions:
      - How much chaos experimentation did my account run last quarter?
      - Can I get cumulative experiment activity totals for a date range?
      instructions:
      - text: Generate the experimentation activity report for account {account_id} from {start} to {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      - text: Build a cumulative chaos experiment activity report for {account_id} between {start} and {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/service/overall/stats/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overall chaos service usage stats by type
      effect: read
      questions:
      - What's the overall chaos service usage broken down by type for my account?
      - Which kinds of chaos services consumed the most usage in a period?
      instructions:
      - text: Show overall usage stats by service type for account {account_id} from {start} to {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      - text: Summarize total chaos usage per type for {account_id} between {start} and {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/service/report/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a chaos service usage report
      effect: read
      questions:
      - Can I produce a service usage report for chaos engineering over a timeframe?
      - Is there a usage report I can hand to finance for a billing period?
      instructions:
      - text: Generate the service usage report for account {account_id} from {start} to {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      - text: Produce a cumulative service usage report for {account_id} covering {start} through {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/service/stats/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get chaos service usage grouped by day or month
      effect: read
      questions:
      - How does my chaos service usage trend day by day?
      - Can I see monthly usage totals for my account's chaos services?
      instructions:
      - text: Show service usage for account {account_id} grouped by {group_by} from {start} to {end}.
        slots:
          account_id: path.accountID
          group_by: query.groupBy
          start: query.startTime
          end: query.endTime
      - text: Chart daily chaos usage for {account_id} between {start} and {end}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/service/{accountID}'].get
  update:
    x-apievangelist-phrasing:
      intent: List per-service chaos usage details
      effect: read
      questions:
      - Which individual services used chaos engineering in a given time frame?
      - Can I sort and page through usage details for each service?
      instructions:
      - text: List service usage details for account {account_id} from {start} to {end}, page {page} of size {limit}.
        slots:
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
          page: query.page
          limit: query.limit
      - text: Show usage details for service {service} in account {account_id} between {start} and {end}.
        slots:
          service: query.service
          account_id: path.accountID
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks'].get
  update:
    x-apievangelist-phrasing:
      intent: List chaos resilience risks
      effect: read
      questions:
      - What resilience risks have been defined for my chaos project?
      - Can I filter risks by category or infrastructure?
      instructions:
      - text: List the risks in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show risks in category {category} for infrastructure {infra}.
        slots:
          category: query.category
          infra: query.infrastructure
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resilience risk
      effect: write
      questions:
      - How do I register a new resilience risk to track with chaos probes?
      - Can a risk be tagged and limited to certain infrastructure types?
      instructions:
      - text: Create a risk named {name} in category {category}.
        slots:
          name: requestBody.name
          category: requestBody.category
      - text: Add risk {name} described as {description} for infrastructure {infra}.
        slots:
          name: requestBody.name
          description: requestBody.description
          infra: requestBody.supportedInfra
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resilience risk
      effect: read
      questions:
      - Can I look up one risk and see its category and tags?
      - What's recorded on a specific chaos risk definition?
      instructions:
      - text: Get risk {identity}.
        slots:
          identity: path.identity
      - text: Show the definition of risk {identity} in project {project}.
        slots:
          identity: path.identity
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a resilience risk
      effect: write
      questions:
      - Can I recategorize an existing risk?
      - Is it possible to change the tags on a risk after it's created?
      instructions:
      - text: Move risk {identity} to category {category}.
        slots:
          identity: path.identity
          category: requestBody.category
      - text: Rename risk {identity} to {name}.
        slots:
          identity: path.identity
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks/{identity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resilience risk
      effect: destructive
      questions:
      - Can I remove a risk we no longer track?
      - What happens to a risk definition when I delete it?
      instructions:
      - text: Delete risk {identity}.
        slots:
          identity: path.identity
      - text: Remove risk {identity} from project {project}.
        slots:
          identity: path.identity
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/risks/{identity}/active-risks'].get
  update:
    x-apievangelist-phrasing:
      intent: List probe executions for a risk
      effect: read
      questions:
      - Which probe runs have flagged a given risk as active?
      - Can I filter a risk's probe executions by status and time window?
      instructions:
      - text: List probe executions for risk {identity}.
        slots:
          identity: path.identity
      - text: Show {status} probe runs against risk {identity} since {start}.
        slots:
          status: query.status
          identity: path.identity
          start: query.startTime
      method: generated
      generated: '2026-09-26'