# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Static IPs API
  version: 1.0.0
extends: openapi/checkly-static-ips-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['/v1/static-ips'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPv4 addresses checks run from
      effect: read
      questions:
      - Which IPv4 addresses do check runs come from so I can allowlist them?
      - Can I get every source IP as one JSON array?
      instructions:
      - text: List all source IPv4 addresses for check runs.
      - text: Give me the IPv4 allowlist for check traffic as JSON.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/static-ips-by-region'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPv4 addresses grouped by region
      effect: read
      questions:
      - What source IPv4 addresses are used in each region?
      - Can I allowlist only the IPs for the regions I run checks from?
      instructions:
      - text: List source IPv4 addresses grouped by region.
      - text: Show the check-run IPv4s for each region.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/static-ips.txt'].get
  update:
    x-apievangelist-phrasing:
      intent: Download IPv4 addresses as a text file
      effect: read
      questions:
      - Is there a plain text list of source IPv4 addresses, one per line?
      - Can I fetch the IPv4 allowlist in a format my firewall script can read line by line?
      instructions:
      - text: Download the source IPv4 list as a TXT file.
      - text: Get the one-per-line text file of check IPv4 addresses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/static-ipv6s'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPv6 addresses checks run from
      effect: read
      questions:
      - Which IPv6 addresses do check runs use?
      - Can I get all source IPv6s as a JSON array?
      instructions:
      - text: List all source IPv6 addresses for check runs.
      - text: Give me the IPv6 allowlist for check traffic as JSON.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/static-ipv6s-by-region'].get
  update:
    x-apievangelist-phrasing:
      intent: List IPv6 addresses by region
      effect: read
      questions:
      - What IPv6 address does each region use for checks?
      - Can I see the IPv6 source mapped per region?
      instructions:
      - text: List source IPv6 addresses by region.
      - text: Show the check-run IPv6 for each region.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/static-ipv6s.txt'].get
  update:
    x-apievangelist-phrasing:
      intent: Download IPv6 addresses as a text file
      effect: read
      questions:
      - Is there a text file of source IPv6 addresses with one per line?
      - Can I pull the IPv6 allowlist as plain text?
      instructions:
      - text: Download the source IPv6 list as a TXT file.
      - text: Get the one-per-line text file of check IPv6 addresses.
      method: generated
      generated: '2026-09-26'