The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Gateway Batch Access API

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

$.info
$.paths['/gateways/rights/batch'].get

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 Batch Access API
  version: 1.0.0
extends: openapi/the-things-network-gatewaybatchaccess-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: 1
- target: $.paths['/gateways/rights/batch'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my rights across several gateways
      effect: read
      questions:
      - Can I verify that I hold certain rights on a whole set of gateways at once?
      - What does it mean when a batch gateway rights check returns no errors?
      instructions:
      - text: Check that I have rights {rights} on the gateways.
        slots:
          rights: query.required.rights
      - text: Assert rights {rights} across my requested gateways.
        slots:
          rights: query.required.rights
      method: generated
      generated: '2026-09-26'