# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Notification Rules API
  version: 1.0.0
extends: openapi/harness-notification-rules-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: 19
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's notification rules
      effect: read
      questions:
      - Which notification rules are set up in my project?
      - Can I filter project notification rules by resource or event type?
      instructions:
      - text: List notification rules in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show project {project} notification rules in org {org} that fire on event {event}.
        slots:
          project: path.project
          event: query.event
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project notification rule
      effect: write
      questions:
      - How do I get alerted about events in a single project?
      - Can a project notification rule use a custom notification template?
      instructions:
      - text: Create a notification rule named {name} in project {project} of org {org}.
        slots:
          name: requestBody.name
          project: path.project
          org: path.org
      - text: Add a project {project} rule in org {org} that notifies channels {notification_channel_refs}.
        slots:
          project: path.project
          org: path.org
          notification_channel_refs: requestBody.notification_channel_refs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project notification rule
      effect: read
      questions:
      - What conditions and channels does a particular project notification rule use?
      - Can I view one project-level rule by its identifier?
      instructions:
      - text: Show notification rule {rule} in project {project} of org {org}.
        slots:
          rule: path.notification-rule
          project: path.project
          org: path.org
      - text: Get the channels on project {project} rule {rule} in org {org}.
        slots:
          project: path.project
          rule: path.notification-rule
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project notification rule
      effect: write
      questions:
      - Can I change which conditions trigger a project's notification rule?
      - How do I switch a project notification rule on or off?
      instructions:
      - text: Set the status of rule {rule} in project {project} of org {org} to {status}.
        slots:
          rule: path.notification-rule
          project: path.project
          org: path.org
          status: requestBody.status
      - text: Change project {project} rule {rule} in org {org} to notify {notification_channel_refs}.
        slots:
          project: path.project
          rule: path.notification-rule
          org: path.org
          notification_channel_refs: requestBody.notification_channel_refs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project notification rule
      effect: destructive
      questions:
      - How do I remove a notification rule from a project?
      - Is deleting a project notification rule permanent?
      instructions:
      - text: Delete notification rule {rule} from project {project} in org {org}.
        slots:
          rule: path.notification-rule
          project: path.project
          org: path.org
      - text: Remove project {project}'s rule {rule} under org {org}.
        slots:
          project: path.project
          rule: path.notification-rule
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/notification-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's notification rules
      effect: read
      questions:
      - What notification rules are defined at the org level?
      - Can I search org-wide notification rules by name?
      instructions:
      - text: List org-level notification rules in {org}.
        slots:
          org: path.org
      - text: Search org {org} notification rules for {search_term}.
        slots:
          org: path.org
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/notification-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an org-level notification rule
      effect: write
      questions:
      - How do I set up a notification rule that covers a whole organization?
      - Can an org notification rule point at existing notification channels?
      instructions:
      - text: Create an org-level notification rule {name} in org {org}.
        slots:
          name: requestBody.name
          org: path.org
      - text: Add an org {org} rule with conditions {notification_conditions}.
        slots:
          org: path.org
          notification_conditions: requestBody.notification_conditions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-wide notification rules
      effect: read
      questions:
      - Which notification rules apply across my entire Harness account?
      - Can I page through account-level notification rules for a given resource?
      instructions:
      - text: List my account-level notification rules.
      - text: Show account notification rules for resource {resource}.
        slots:
          resource: query.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level notification rule
      effect: write
      questions:
      - Can I create one notification rule that applies to the whole account?
      - What goes into an account-wide notification rule?
      instructions:
      - text: Create an account-level notification rule called {name}.
        slots:
          name: requestBody.name
      - text: Add an account-wide rule {identifier} notifying {notification_channel_refs}.
        slots:
          identifier: requestBody.identifier
          notification_channel_refs: requestBody.notification_channel_refs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/notification-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org-level notification rule
      effect: read
      questions:
      - What does a specific organization notification rule contain?
      - Can I fetch one org rule by identifier?
      instructions:
      - text: Show org {org} notification rule {rule}.
        slots:
          org: path.org
          rule: path.notification-rule
      - text: Get the conditions of org-level rule {rule} in {org}.
        slots:
          rule: path.notification-rule
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/notification-rules/{notification-rule}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an org-level notification rule
      effect: write
      questions:
      - Can I edit an organization's notification rule conditions?
      - How do I disable an org notification rule without deleting it?
      instructions:
      - text: Set org {org} rule {rule} status to {status}.
        slots:
          org: path.org
          rule: path.notification-rule
          status: requestBody.status
      - text: Rename org-level rule {rule} in {org} to {name}.
        slots:
          rule: path.notification-rule
          org: path.org
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/notification-rules/{notification-rule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org-level notification rule
      effect: destructive
      questions:
      - How do I remove a notification rule from an organization?
      - Does deleting an org rule stop its alerts immediately?
      instructions:
      - text: Delete org {org} notification rule {rule}.
        slots:
          org: path.org
          rule: path.notification-rule
      - text: Remove org-level rule {rule} from {org}.
        slots:
          rule: path.notification-rule
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level notification rule
      effect: read
      questions:
      - What does an account-wide notification rule look like in detail?
      - Can I fetch a single account-level rule by id?
      instructions:
      - text: Show account-level notification rule {rule}.
        slots:
          rule: path.notification-rule
      - text: Get the channels on account rule {rule}.
        slots:
          rule: path.notification-rule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-rules/{notification-rule}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level notification rule
      effect: write
      questions:
      - Can I change the conditions on an account-wide notification rule?
      - How do I swap the template used by an account notification rule?
      instructions:
      - text: Set account rule {rule} status to {status}.
        slots:
          rule: path.notification-rule
          status: requestBody.status
      - text: Use template {custom_notification_template_ref} on account-level rule {rule}.
        slots:
          custom_notification_template_ref: requestBody.custom_notification_template_ref
          rule: path.notification-rule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-rules/{notification-rule}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level notification rule
      effect: destructive
      questions:
      - How do I delete a notification rule that applies to the whole account?
      - Can an account-wide notification rule be removed by identifier?
      instructions:
      - text: Delete account-level notification rule {rule}.
        slots:
          rule: path.notification-rule
      - text: Remove account rule {rule}.
        slots:
          rule: path.notification-rule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/notification-rules/validate-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a project rule identifier is available
      effect: read
      questions:
      - Is a notification rule identifier already taken in my project?
      - Can I validate a project rule id before creating it?
      instructions:
      - text: Check whether rule identifier {rule} is valid in project {project} of org {org}.
        slots:
          rule: path.notification-rule
          project: path.project
          org: path.org
      - text: Validate {rule} as a new notification rule id for project {project} in {org}.
        slots:
          rule: path.notification-rule
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/validate-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an org rule identifier is available
      effect: read
      questions:
      - Is a notification rule id already used at the org level?
      - Can I check an org rule identifier before I create the rule?
      instructions:
      - text: Validate rule identifier {rule} at the org level for {org}.
        slots:
          rule: path.notification-rule
          org: path.org
      - text: Check if org {org} already has a rule id {rule}.
        slots:
          org: path.org
          rule: path.notification-rule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/validate-rules/{notification-rule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an account rule identifier is available
      effect: read
      questions:
      - Is an account-level notification rule identifier free to use?
      - Can I validate an account rule id up front?
      instructions:
      - text: Validate {rule} as an account-level notification rule identifier.
        slots:
          rule: path.notification-rule
      - text: Check if the account already uses rule id {rule}.
        slots:
          rule: path.notification-rule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/notification-resource-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List notifiable entities and events
      effect: read
      questions:
      - Which entities and events can Harness send notifications about?
      - What event types are available when building a notification rule?
      instructions:
      - text: List the entities and events I can build notification rules on.
      - text: Show every notification resource type with its supported events.
      method: generated
      generated: '2026-09-26'