The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Managed Gateway Wi Fi Profile…

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

$.info
$.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}'].get
$.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}'].post
$.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile.profile_id}'].put
$.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].get
$.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].delete
$.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}'].get
$.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}'].post
$.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{profile.profile_id}'].put
$.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{profile_id}'].get
$.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{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 — Gateway Server Managed Gateway Wi Fi Profile…
  version: 1.0.0
extends: openapi/the-things-network-managedgatewaywifiprofileconfigurationservice-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: 10
- target: $.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's WiFi profiles
      effect: read
      questions:
      - Which WiFi profiles has my organization saved for managed gateways?
      - Can I page through an organization's gateway WiFi profiles?
      instructions:
      - text: List WiFi profiles for organization {organization_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Show {limit} organization WiFi profiles per page for {organization_id}.
        slots:
          limit: query.limit
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WiFi profile for an organization
      effect: write
      questions:
      - How do I save a WiFi network profile that my organization's managed gateways can use?
      - Can an organization own a shared WiFi profile for gateways?
      instructions:
      - text: Create WiFi profile {profile} for organization {organization_id}.
        slots:
          profile: requestBody.profile
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Add a new shared gateway WiFi profile to organization {organization_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile.profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's WiFi profile
      effect: write
      questions:
      - How do I change the SSID or credentials in an organization's gateway WiFi profile?
      - Can I update only some fields of an organization WiFi profile?
      instructions:
      - text: Update WiFi profile {profile_id} of organization {organization_id} with {profile}.
        slots:
          profile_id: path.profile.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
          profile: requestBody.profile
      - text: Change fields {field_mask} of organization {organization_id} WiFi profile {profile_id}.
        slots:
          field_mask: requestBody.field_mask
          organization_id: path.collaborator.organization_ids.organization_id
          profile_id: path.profile.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's WiFi profile
      effect: read
      questions:
      - What settings are stored in one of my organization's gateway WiFi profiles?
      - Can I fetch an organization WiFi profile by its profile ID?
      instructions:
      - text: Show WiFi profile {profile_id} of organization {organization_id}.
        slots:
          profile_id: path.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Get the saved network settings in organization {organization_id} profile {profile_id}.
        slots:
          profile_id: path.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization's WiFi profile
      effect: destructive
      questions:
      - How do I remove an old WiFi profile from my organization?
      - Can I delete an organization's managed gateway WiFi profile?
      instructions:
      - text: Delete WiFi profile {profile_id} from organization {organization_id}.
        slots:
          profile_id: path.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Remove organization {organization_id}'s gateway WiFi profile {profile_id}.
        slots:
          profile_id: path.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's WiFi profiles
      effect: read
      questions:
      - Which WiFi profiles have I saved on my own user account for managed gateways?
      - Can I list a user's personal gateway WiFi profiles?
      instructions:
      - text: List WiFi profiles for user {user_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
      - text: Show page {page} of personal gateway WiFi profiles for user {user_id}.
        slots:
          page: query.page
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WiFi profile for a user
      effect: write
      questions:
      - How do I save a personal WiFi profile for my managed gateway?
      - Can a single user own a gateway WiFi profile instead of an organization?
      instructions:
      - text: Create WiFi profile {profile} for user {user_id}.
        slots:
          profile: requestBody.profile
          user_id: path.collaborator.user_ids.user_id
      - text: Add a personal gateway WiFi profile to user account {user_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{profile.profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's WiFi profile
      effect: write
      questions:
      - How do I edit a WiFi profile stored on my user account?
      - Can I change just the password in a user's gateway WiFi profile?
      instructions:
      - text: Update WiFi profile {profile_id} of user {user_id} with {profile}.
        slots:
          profile_id: path.profile.profile_id
          user_id: path.collaborator.user_ids.user_id
          profile: requestBody.profile
      - text: Change fields {field_mask} of user {user_id} WiFi profile {profile_id}.
        slots:
          field_mask: requestBody.field_mask
          user_id: path.collaborator.user_ids.user_id
          profile_id: path.profile.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's WiFi profile
      effect: read
      questions:
      - What's in a WiFi profile saved under my user account?
      - Can I read a user's gateway WiFi profile by ID?
      instructions:
      - text: Show WiFi profile {profile_id} of user {user_id}.
        slots:
          profile_id: path.profile_id
          user_id: path.collaborator.user_ids.user_id
      - text: Get the saved network settings in user {user_id}'s profile {profile_id}.
        slots:
          profile_id: path.profile_id
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/wifi/users/{collaborator.user_ids.user_id}/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's WiFi profile
      effect: destructive
      questions:
      - How do I delete a WiFi profile from my user account?
      - Can I remove a personal managed gateway WiFi profile?
      instructions:
      - text: Delete WiFi profile {profile_id} from user {user_id}.
        slots:
          profile_id: path.profile_id
          user_id: path.collaborator.user_ids.user_id
      - text: Remove user {user_id}'s personal gateway WiFi profile {profile_id}.
        slots:
          profile_id: path.profile_id
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'