The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Gateway Configuration Service…

3 actions 3 updates phrasing extends openapi/the-things-network-gatewayconfigurationservice-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['/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{filename}'].get
$.paths['/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{type}/{filename}'].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 Configuration Service…
  version: 1.0.0
extends: openapi/the-things-network-gatewayconfigurationservice-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['/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a gateway configuration file
      effect: read
      questions:
      - How do I download the configuration file for my gateway in a given format?
      - Can I pass the configuration type as a query parameter instead of a path segment?
      instructions:
      - text: Download {filename} in format {format} for gateway {gateway_id}.
        slots:
          filename: path.filename
          format: path.format
          gateway_id: path.gateway_ids.gateway_id
      - text: Get gateway {gateway_id}'s {format} config file {filename} of type {type} via query.
        slots:
          gateway_id: path.gateway_ids.gateway_id
          format: path.format
          filename: path.filename
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/configuration/{gateway_ids.gateway_id}/{format}/{type}/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a typed gateway configuration file
      effect: read
      questions:
      - Can I fetch a gateway config file where the type is part of the URL path?
      - Which URL form lets me request a gateway configuration by format, type and filename together?
      instructions:
      - text: Download {filename} of type {type} in format {format} for gateway {gateway_id} using the typed path.
        slots:
          filename: path.filename
          type: path.type
          format: path.format
          gateway_id: path.gateway_ids.gateway_id
      - text: Fetch gateway {gateway_id}'s {format}/{type} configuration file {filename}.
        slots:
          gateway_id: path.gateway_ids.gateway_id
          format: path.format
          type: path.type
          filename: path.filename
      method: generated
      generated: '2026-09-26'