Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Routing Rules API

3 actions 3 updates phrasing extends openapi/impact-routing-rules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules'].get

$.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules/{RuleId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brand Routing Rules API
  version: 1.0.0
extends: openapi/impact-routing-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: 2
- target: $.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's routing rules
      effect: read
      questions:
      - Which block and redirect rules are set on my program?
      - Can I filter routing rules by state or who created them?
      instructions:
      - text: List routing rules on program {program} in account {sid}.
        slots:
          sid: path.AccountSID
          program: path.ProgramId
      - text: Show program {program} routing rules in state {state}.
        slots:
          program: path.ProgramId
          state: query.State
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules/{RuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a routing rule's details
      effect: read
      questions:
      - What condition and action does a specific routing rule use?
      - Can I look up one block/redirect rule by ID?
      instructions:
      - text: Get routing rule {rule} on program {program} in account {sid}.
        slots:
          sid: path.AccountSID
          program: path.ProgramId
          rule: path.RuleId
      - text: Show the condition and action of rule {rule} in program {program}.
        slots:
          program: path.ProgramId
          rule: path.RuleId
      method: generated
      generated: '2026-09-26'