The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Network Server Ns MAC Settings Profile…

6 actions 6 updates phrasing extends openapi/the-things-network-nsmacsettingsprofileregistry-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['/ns/applications/{application_ids.application_id}/mac_settings_profiles'].get
$.paths['/ns/applications/{mac_settings_profile.ids.application_ids.application_id}/mac_settings_profiles'].post
$.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].get
$.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].put
$.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].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 — Network Server Ns MAC Settings Profile…
  version: 1.0.0
extends: openapi/the-things-network-nsmacsettingsprofileregistry-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['/ns/applications/{application_ids.application_id}/mac_settings_profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's MAC settings profiles
      effect: read
      questions:
      - Which MAC settings profiles exist in my application?
      - Can I page through MAC settings profiles in a chosen order?
      instructions:
      - text: List MAC settings profiles in application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Show {limit} MAC profiles per page for app {application_id}.
        slots:
          limit: query.limit
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{mac_settings_profile.ids.application_ids.application_id}/mac_settings_profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a MAC settings profile
      effect: write
      questions:
      - How do I create a reusable MAC settings profile for devices in my application?
      - Can I define shared LoRaWAN MAC settings once and apply them to many devices?
      instructions:
      - text: Create MAC settings profile {mac_settings_profile} in application {application_id}.
        slots:
          mac_settings_profile: requestBody.mac_settings_profile
          application_id: path.mac_settings_profile.ids.application_ids.application_id
      - text: Add a new MAC profile to app {application_id}.
        slots:
          application_id: path.mac_settings_profile.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a MAC settings profile
      effect: read
      questions:
      - What MAC settings are in a specific profile?
      - Can I read one MAC settings profile with only certain fields?
      instructions:
      - text: Show MAC settings profile {profile_id} in application {application_id}.
        slots:
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
      - text: Get the {field_mask} of MAC profile {profile_id} in app {application_id}.
        slots:
          field_mask: query.field_mask
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a MAC settings profile
      effect: write
      questions:
      - How do I change the settings in an existing MAC settings profile?
      - Can I update selected fields of a MAC profile with a field mask?
      instructions:
      - text: Update MAC settings profile {profile_id} in application {application_id} to {mac_settings_profile}.
        slots:
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
          mac_settings_profile: requestBody.mac_settings_profile
      - text: Edit MAC profile {profile_id} of app {application_id}.
        slots:
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a MAC settings profile
      effect: destructive
      questions:
      - How do I remove a MAC settings profile I no longer use?
      - Can I delete one MAC profile from an application?
      instructions:
      - text: Delete MAC settings profile {profile_id} from application {application_id}.
        slots:
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
      - text: Remove MAC profile {profile_id} in app {application_id}.
        slots:
          profile_id: path.mac_settings_profile_ids.profile_id
          application_id: path.mac_settings_profile_ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'