Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Srm Notification API

6 actions 6 updates phrasing extends openapi/harness-srm-notification-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['/cv/api/notification-rule/{identifier}'].get
$.paths['/cv/api/notification-rule/{identifier}'].put
$.paths['/cv/api/notification-rule/{identifier}'].delete
$.paths['/cv/api/notification-rule'].get
$.paths['/cv/api/notification-rule'].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 Srm Notification API
  version: 1.0.0
extends: openapi/harness-srm-notification-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['/cv/api/notification-rule/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service reliability notification rule
      effect: read
      questions:
      - What conditions and channel does a specific SRM notification rule use?
      - Can I look up one monitored-service notification rule by its identifier?
      instructions:
      - text: Show notification rule {identifier}.
        slots:
          identifier: path.identifier
      - text: Get the conditions of SRM notification rule {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/notification-rule/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a service reliability notification rule
      effect: write
      questions:
      - Can I change the conditions that trigger an existing SRM notification rule?
      - How do I switch a notification rule to send to a different channel?
      instructions:
      - text: Update notification rule {identifier} with conditions {conditions}.
        slots:
          identifier: path.identifier
          conditions: requestBody.conditions
      - text: Change notification rule {identifier} to notify via {notificationMethod}.
        slots:
          identifier: path.identifier
          notificationMethod: requestBody.notificationMethod
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/notification-rule/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service reliability notification rule
      effect: destructive
      questions:
      - Can I remove an SRM notification rule that's too noisy?
      - What happens to alerts once a notification rule is deleted?
      instructions:
      - text: Delete notification rule {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove SRM notification rule {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/notification-rule'].get
  update:
    x-apievangelist-phrasing:
      intent: List service reliability notification rules
      effect: read
      questions:
      - Which notification rules are set up for monitored services and SLOs in my project?
      - Can I page through all SRM notification rules?
      instructions:
      - text: List notification rules, page {pageNumber} with {pageSize} per page.
        slots:
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      - text: Show the SRM notification rules {notificationRuleIdentifiers}, page {pageNumber} of size {pageSize}.
        slots:
          notificationRuleIdentifiers: query.notificationRuleIdentifiers
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/notification-rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service reliability notification rule
      effect: write
      questions:
      - How do I set up a new SRM notification rule?
      - Can I pick the notification channel when creating an SRM alert rule?
      instructions:
      - text: Create notification rule {name} of type {type} with conditions {conditions}.
        slots:
          name: requestBody.name
          type: requestBody.type
          conditions: requestBody.conditions
      - text: Add a new SRM notification rule {identifier} that notifies via {notificationMethod}.
        slots:
          identifier: requestBody.identifier
          notificationMethod: requestBody.notificationMethod
      method: generated
      generated: '2026-09-26'