The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Gateway Claiming Server API

6 actions 6 updates phrasing extends openapi/the-things-network-gatewayclaimingserver-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['/gcls/claim'].post
$.paths['/gcls/claim/info'].post
$.paths['/gcls/claim/{gateway_id}'].delete
$.paths['/gcls/gateways/{gateway_ids.gateway_id}/authorize'].post
$.paths['/gcls/gateways/{gateway_id}/authorize'].delete

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 Claiming Server API
  version: 1.0.0
extends: openapi/the-things-network-gatewayclaimingserver-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['/gcls/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a gateway
      effect: write
      questions:
      - How do I claim a gateway I bought using its claim authentication code?
      - Can I claim a gateway by scanning its QR code?
      - Can I choose the frequency plan and Gateway Server address when claiming?
      instructions:
      - text: Claim the gateway in QR code {qr_code} as {target_gateway_id}.
        slots:
          qr_code: requestBody.qr_code
          target_gateway_id: requestBody.target_gateway_id
      - text: Claim gateway {authenticated_identifiers} with ID {target_gateway_id} on frequency plan {target_frequency_plan_id}.
        slots:
          authenticated_identifiers: requestBody.authenticated_identifiers
          target_gateway_id: requestBody.target_gateway_id
          target_frequency_plan_id: requestBody.target_frequency_plan_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcls/claim/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a gateway EUI can be claimed
      effect: read
      questions:
      - Is claiming supported for my gateway's EUI?
      - Can I find out whether a gateway is claimable before trying?
      instructions:
      - text: Check whether gateway EUI {eui} can be claimed.
        slots:
          eui: requestBody.eui
      - text: Look up claiming availability for EUI {eui}.
        slots:
          eui: requestBody.eui
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcls/claim/{gateway_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unclaim a gateway
      effect: destructive
      questions:
      - How do I release a gateway I claimed so someone else can claim it?
      - Is the gateway looked up by ID or EUI when unclaiming?
      instructions:
      - text: Unclaim gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Release my claim on gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcls/gateways/{gateway_ids.gateway_id}/authorize'].post
  update:
    x-apievangelist-phrasing:
      intent: Authorize a gateway for claiming (deprecated)
      effect: write
      questions:
      - What did the deprecated gateway claim authorization do?
      - Is authorizing a gateway for claiming still supported?
      instructions:
      - text: Authorize gateway {gateway_id} for claiming with API key {api_key} using the deprecated endpoint.
        slots:
          gateway_id: path.gateway_ids.gateway_id
          api_key: requestBody.api_key
      - text: Allow gateway {gateway_id} to be claimed via the legacy authorize call.
        slots:
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcls/gateways/{gateway_id}/authorize'].delete
  update:
    x-apievangelist-phrasing:
      intent: Lock a gateway against claiming (deprecated)
      effect: destructive
      questions:
      - How did I stop a gateway from being claimed with the old unauthorize call?
      - Is locking gateways against claiming being removed?
      instructions:
      - text: Unauthorize gateway {gateway_id} for claiming using the deprecated endpoint.
        slots:
          gateway_id: path.gateway_id
      - text: Lock gateway {gateway_id} so it cannot be claimed.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'