The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — End Device Registry End Device QR Code…

6 actions 6 updates phrasing extends openapi/the-things-network-enddeviceqrcodegenerator-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 6

$.info
$.paths['/qr-codes/end-devices'].post
$.paths['/qr-codes/end-devices/formats'].get
$.paths['/qr-codes/end-devices/formats/{format_id}'].get
$.paths['/qr-codes/end-devices/parse'].post
$.paths['/qr-codes/end-devices/{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 — End Device Registry End Device QR Code…
  version: 1.0.0
extends: openapi/the-things-network-enddeviceqrcodegenerator-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['/qr-codes/end-devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a QR code for an end device
      effect: write
      questions:
      - How do I generate an onboarding QR code for one of my end devices?
      - Can I get the QR code as an image in a chosen format?
      instructions:
      - text: Generate a {format_id} QR code for end device {end_device}.
        slots:
          format_id: requestBody.format_id
          end_device: requestBody.end_device
      - text: Render a QR code image {image} for device {end_device}.
        slots:
          image: requestBody.image
          end_device: requestBody.end_device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qr-codes/end-devices/formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported end device QR code formats
      effect: read
      questions:
      - Which QR code formats does The Things Stack support for devices?
      - What formats can I generate or parse device QR codes in?
      instructions:
      - text: List the supported end device QR code formats.
      - text: Show all device QR code formats available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qr-codes/end-devices/formats/{format_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an end device QR code format
      effect: read
      questions:
      - What fields does a specific device QR code format contain?
      - Can I look up one QR code format by its ID?
      instructions:
      - text: Show QR code format {format_id}.
        slots:
          format_id: path.format_id
      - text: Describe device QR format {format_id}.
        slots:
          format_id: path.format_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qr-codes/end-devices/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a device QR code of any known format
      effect: read
      questions:
      - Can I decode a device QR code without knowing its format first?
      - What information can be pulled out of a scanned device QR code?
      instructions:
      - text: Parse device QR code {qr_code}.
        slots:
          qr_code: requestBody.qr_code
      - text: Decode QR code {qr_code}, trying format {format_id}.
        slots:
          qr_code: requestBody.qr_code
          format_id: requestBody.format_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/qr-codes/end-devices/{format_id}/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse a device QR code in a given format
      effect: read
      questions:
      - How do I decode a device QR code when I already know its format ID?
      - Can I parse a QR code against one format named in the URL?
      instructions:
      - text: Parse QR code {qr_code} using format {format_id} from the path.
        slots:
          qr_code: requestBody.qr_code
          format_id: path.format_id
      - text: Read the device data in {qr_code} as format {format_id}.
        slots:
          qr_code: requestBody.qr_code
          format_id: path.format_id
      method: generated
      generated: '2026-09-26'