The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Application Server As API

6 actions 6 updates phrasing extends openapi/the-things-network-as-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['/as/applications/{application_ids.application_id}/link'].get

$.paths['/as/applications/{application_ids.application_id}/link'].put

$.paths['/as/applications/{application_id}/link'].delete

$.paths['/as/applications/{application_id}/link/stats'].get

$.paths['/as/configuration'].get

OpenAPI Overlay

# 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 — Application Server As API
  version: 1.0.0
extends: openapi/the-things-network-as-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['/as/applications/{application_ids.application_id}/link'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's Network Server link config
      effect: read
      questions:
      - How is my application linked from the Application Server to the Network Server?
      - Where can I see the link configuration without statistics?
      instructions:
      - text: Show the Network Server link configuration for application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Get fields {field_mask} of the link config for {application_id}.
        slots:
          field_mask: query.field_mask
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{application_ids.application_id}/link'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure an application's Network Server link
      effect: write
      questions:
      - How do I link my application to a Network Server?
      - Does setting the link wait for the connection to be established?
      instructions:
      - text: Set the Network Server link for application {application_id} to {link}.
        slots:
          application_id: path.application_ids.application_id
          link: requestBody.link
      - text: Update link fields {field_mask} for application {application_id}.
        slots:
          field_mask: requestBody.field_mask
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{application_id}/link'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an application's Network Server link
      effect: destructive
      questions:
      - How do I unlink my application from the Network Server?
      - Can I delete the Application Server link configuration?
      instructions:
      - text: Delete the Network Server link for application {application_id}.
        slots:
          application_id: path.application_id
      - text: Unlink application {application_id} from its Network Server.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/applications/{application_id}/link/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link statistics and errors
      effect: read
      questions:
      - Is my application's link to the Network Server healthy?
      - What error comes back if the application link has failed?
      instructions:
      - text: Show link statistics for application {application_id}.
        slots:
          application_id: path.application_id
      - text: Check whether application {application_id}'s link has any errors.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Application Server configuration
      effect: read
      questions:
      - What configuration is the Application Server running with?
      - Can I read the Application Server's public settings?
      instructions:
      - text: Show the Application Server configuration.
      - text: Get the current Application Server settings.
      method: generated
      generated: '2026-09-26'