The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Application Server Application Activation…

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

$.info
$.paths['/js/applications/{application_ids.application_id}/settings'].get
$.paths['/js/applications/{application_ids.application_id}/settings'].post
$.paths['/js/applications/{application_ids.application_id}/settings'].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 — Application Server Application Activation…
  version: 1.0.0
extends: openapi/the-things-network-applicationactivationsettingregistry-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: 3
- target: $.paths['/js/applications/{application_ids.application_id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's activation settings
      effect: read
      questions:
      - What activation settings does the Join Server hold for my application?
      - Can I read only certain activation setting fields for an app?
      instructions:
      - text: Show the activation settings of application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Get the {field_mask} activation settings for app {application_id}.
        slots:
          field_mask: query.field_mask
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/js/applications/{application_ids.application_id}/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update application activation settings
      effect: write
      questions:
      - How do I configure the Join Server activation settings for my application?
      - Can I change just part of an app's activation settings using a field mask?
      instructions:
      - text: Set activation settings {settings} for application {application_id}.
        slots:
          settings: requestBody.settings
          application_id: path.application_ids.application_id
      - text: Update fields {field_mask} of app {application_id}'s activation settings.
        slots:
          field_mask: requestBody.field_mask
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/js/applications/{application_ids.application_id}/settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application's activation settings
      effect: destructive
      questions:
      - Can I clear the activation settings stored for an application?
      - What removes an app's Join Server activation configuration entirely?
      instructions:
      - text: Delete the activation settings of application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Clear app {application_id}'s activation configuration.
        slots:
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'