The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Gateway QR Code Generator API

3 actions 3 updates phrasing extends openapi/the-things-network-gatewayqrcodegenerator-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for The Things Network / The Things Stack's API. It is a proposal applied on top of the contract, not a document The Things Network / The Things Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/qr-codes/gateways/parse'].post
$.paths['/qr-codes/gateways/{format_id}/parse'].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 Things Stack — Gateway Server Gateway QR Code Generator API
  version: 1.0.0
extends: openapi/the-things-network-gatewayqrcodegenerator-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['/qr-codes/gateways/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a gateway QR code
      effect: read
      questions:
      - How do I read the gateway details encoded in a QR code?
      - Can the format be detected automatically when parsing a gateway QR code?
      instructions:
      - text: Parse gateway QR code {qr_code}.
        slots:
          qr_code: requestBody.qr_code
      - text: Decode gateway QR code {qr_code} with optional format {format_id} in the body.
        slots:
          qr_code: requestBody.qr_code
          format_id: requestBody.format_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qr-codes/gateways/{format_id}/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a gateway QR code of a known format
      effect: read
      questions:
      - Can I parse a gateway QR code when I already know its format?
      - Which fields come out of a gateway QR code in a specific format?
      instructions:
      - text: Parse gateway QR code {qr_code} using the format {format_id} path.
        slots:
          qr_code: requestBody.qr_code
          format_id: path.format_id
      - text: Read gateway info from QR {qr_code} as format {format_id}.
        slots:
          qr_code: requestBody.qr_code
          format_id: path.format_id
      method: generated
      generated: '2026-09-26'