API Evangelist conversational phrasing for Things Stack — Identity Server Configuration API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Things Stack — Identity Server Configuration API
  version: 1.0.0
extends: openapi/the-things-network-configuration-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['/configuration/bands'].get
  update:
    x-apievangelist-phrasing:
      intent: List LoRaWAN bands
      effect: read
      questions:
      - Which LoRaWAN regional bands does The Things Stack support?
      - Can I filter band definitions by PHY version?
      instructions:
      - text: List all supported LoRaWAN bands.
      - text: List bands filtered by band {band_id} and PHY version {phy_version} as query values.
        slots:
          band_id: query.band_id
          phy_version: query.phy_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configuration/bands/{band_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a band's definitions across PHY versions
      effect: read
      questions:
      - What are the parameters of a specific band like EU_863_870?
      - Can I see one band's definition for every PHY version?
      instructions:
      - text: Show band {band_id}'s definitions for all PHY versions.
        slots:
          band_id: path.band_id
      - text: Get band {band_id} and narrow to PHY version {phy_version} via query.
        slots:
          band_id: path.band_id
          phy_version: query.phy_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configuration/bands/{band_id}/{phy_version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a band for one PHY version
      effect: read
      questions:
      - What does a band look like under one exact regional parameters version?
      - Can I fetch a single band and PHY version combination?
      instructions:
      - text: Show band {band_id} for PHY version {phy_version} using the version path.
        slots:
          band_id: path.band_id
          phy_version: path.phy_version
      - text: Get the {band_id} definition at regional parameters version {phy_version}.
        slots:
          band_id: path.band_id
          phy_version: path.phy_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configuration/frequency-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List frequency plans
      effect: read
      questions:
      - Which frequency plans are available for my region?
      - Can I list only frequency plans meant for gateways?
      - What plans exist for a given base frequency like 868 MHz?
      instructions:
      - text: List all frequency plans.
      - text: List frequency plans for band {band_id}.
        slots:
          band_id: query.band_id
      - text: List gateway-only frequency plans at base frequency {base_frequency}, gateways_only {gateways_only}.
        slots:
          base_frequency: query.base_frequency
          gateways_only: query.gateways_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configuration/phy-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported PHY versions for a band
      effect: read
      questions:
      - Which LoRaWAN PHY versions are supported for my band?
      - What regional parameters versions can I choose for a band ID?
      instructions:
      - text: List supported PHY versions for band {band_id}.
        slots:
          band_id: query.band_id
      - text: Show all supported LoRaWAN PHY versions.
      method: generated
      generated: '2026-09-26'