Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Exemption Rules API

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

$.info
$.paths['/sto/api/v2/exemption-rules'].get
$.paths['/sto/api/v2/exemption-rules'].post
$.paths['/sto/api/v2/exemption-rules/{id}'].get
$.paths['/sto/api/v2/exemption-rules/{id}'].put
$.paths['/sto/api/v2/exemption-rules/{id}'].delete
$.paths['/sto/api/v2/exemption-rules/constraints'].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 Exemption Rules API
  version: 1.0.0
extends: openapi/harness-exemptionrules-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: 6
- target: $.paths['/sto/api/v2/exemption-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List security exemption rules
      effect: read
      questions:
      - Which exemption rules are configured for security findings in my account?
      - Can I page through exemption rules a set number at a time?
      instructions:
      - text: List exemption rules for account {account}.
        slots:
          account: query.accountId
      - text: Show page {page} of exemption rules in account {account}, {size} per page.
        slots:
          page: query.page
          account: query.accountId
          size: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/exemption-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security exemption rule
      effect: write
      questions:
      - How do I set up a rule that governs how security issue exemptions are handled?
      - Can I give a new exemption rule a priority and leave it disabled at first?
      instructions:
      - text: Create exemption rule {name} in account {account} with conditions {conditions} and actions {actions}, as user {user}.
        slots:
          name: requestBody.name
          account: query.accountId
          conditions: requestBody.conditions
          actions: requestBody.actions
          user: requestBody.userId
      - text: Add exemption rule {name} at priority {priority} to account {account} with conditions {conditions}, actions {actions}, user {user}.
        slots:
          name: requestBody.name
          priority: requestBody.priority
          account: query.accountId
          conditions: requestBody.conditions
          actions: requestBody.actions
          user: requestBody.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/exemption-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one exemption rule
      effect: read
      questions:
      - What conditions and actions does a specific exemption rule have?
      - Can I look up an exemption rule by its ID?
      instructions:
      - text: Get exemption rule {id} in account {account}.
        slots:
          id: path.id
          account: query.accountId
      - text: Show the conditions and actions of exemption rule {id} for account {account}.
        slots:
          id: path.id
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/exemption-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exemption rule
      effect: write
      questions:
      - How do I disable an existing exemption rule without deleting it?
      - Can I change the priority of an exemption rule?
      instructions:
      - text: Set exemption rule {id} in account {account} to enabled {enabled}, as user {user}.
        slots:
          id: path.id
          account: query.accountId
          enabled: requestBody.enabled
          user: requestBody.userId
      - text: Change the priority of exemption rule {id} in account {account} to {priority}, as user {user}.
        slots:
          id: path.id
          account: query.accountId
          priority: requestBody.priority
          user: requestBody.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/exemption-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exemption rule
      effect: destructive
      questions:
      - How do I remove an exemption rule entirely?
      - Can an exemption rule be deleted by its ID?
      instructions:
      - text: Delete exemption rule {id} in account {account}.
        slots:
          id: path.id
          account: query.accountId
      - text: Remove the exemption rule {id} from account {account} permanently.
        slots:
          id: path.id
          account: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/exemption-rules/constraints'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the strictest constraint for an exemption
      effect: read
      questions:
      - What constraints apply before I request an exemption for a security issue?
      - How many issues or occurrences can I check exemption constraints for in one request?
      instructions:
      - text: Get exemption constraints for items {items} in org {org}, project {project}, account {account}.
        slots:
          items: requestBody.items
          org: requestBody.orgId
          project: requestBody.projectId
          account: query.accountId
      - text: Check the strictest exemption constraint for {type} {items} in org {org}, project {project}, account {account}.
        slots:
          type: requestBody.type
          items: requestBody.items
          org: requestBody.orgId
          project: requestBody.projectId
          account: query.accountId
      method: generated
      generated: '2026-09-26'