The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Gateway Server Managed Gateway Ethernet…

11 actions 11 updates phrasing extends openapi/the-things-network-managedgatewayethernetprofileconfigurationservice-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/ethernet/organizations/{collaborator.organization_ids.organization_id}'].get
$.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}'].post
$.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile.profile_id}'].put
$.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].get
$.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].delete
$.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}'].get
$.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}'].post
$.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}/{profile.profile_id}'].put
$.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}/{profile_id}'].get
$.paths['/gcs/gateways/profiles/ethernet/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 Ethernet…
  version: 1.0.0
extends: openapi/the-things-network-managedgatewayethernetprofileconfigurationservice-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/ethernet/organizations/{collaborator.organization_ids.organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's gateway Ethernet profiles
      effect: read
      questions:
      - Which Ethernet profiles has my organization saved for managed gateways?
      - Can I page through an organization's managed gateway Ethernet profiles?
      instructions:
      - text: List managed gateway Ethernet profiles for organization {organization_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Show {limit} Ethernet profiles per page for organization {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/ethernet/organizations/{collaborator.organization_ids.organization_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Ethernet profile for an organization
      effect: write
      questions:
      - How do I save a reusable Ethernet network profile for my organization's managed gateways?
      - Can an organization own a shared Ethernet configuration for its gateways?
      instructions:
      - text: Create Ethernet profile {profile} for organization {organization_id}.
        slots:
          profile: requestBody.profile
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Save a shared Ethernet profile {profile} owned by organization {organization_id}.
        slots:
          profile: requestBody.profile
          organization_id: path.collaborator.organization_ids.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile.profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's Ethernet profile
      effect: write
      questions:
      - How do I change the settings of an organization's managed gateway Ethernet profile?
      - Can I update only some fields of an organization Ethernet profile?
      instructions:
      - text: Update Ethernet profile {profile_id} of organization {organization_id}.
        slots:
          profile_id: path.profile.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Change organization {organization_id}'s Ethernet profile {profile_id} to {profile}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          profile_id: path.profile.profile_id
          profile: requestBody.profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's Ethernet profile
      effect: read
      questions:
      - What settings are in one of my organization's Ethernet profiles?
      - Can I fetch a single organization-owned Ethernet profile by ID?
      instructions:
      - text: Show Ethernet profile {profile_id} of organization {organization_id}.
        slots:
          profile_id: path.profile_id
          organization_id: path.collaborator.organization_ids.organization_id
      - text: Get the {field_mask} of organization {organization_id}'s Ethernet profile {profile_id}.
        slots:
          field_mask: query.field_mask
          organization_id: path.collaborator.organization_ids.organization_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/organizations/{collaborator.organization_ids.organization_id}/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization's Ethernet profile
      effect: destructive
      questions:
      - How do I remove an Ethernet profile my organization no longer uses?
      - Can I delete an organization-owned managed gateway Ethernet profile?
      instructions:
      - text: Delete Ethernet 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 Ethernet profile {profile_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's gateway Ethernet profiles
      effect: read
      questions:
      - Which managed gateway Ethernet profiles are saved under my personal account?
      - Can I list the Ethernet profiles a specific user owns?
      instructions:
      - text: List managed gateway Ethernet profiles for user {user_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
      - text: Show {limit} Ethernet profiles per page for user {user_id}.
        slots:
          limit: query.limit
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Ethernet profile for a user
      effect: write
      questions:
      - How do I save an Ethernet network profile to my own user account for a managed gateway?
      - Can a user create a personal Ethernet configuration profile?
      instructions:
      - text: Create Ethernet profile {profile} for user {user_id}.
        slots:
          profile: requestBody.profile
          user_id: path.collaborator.user_ids.user_id
      - text: Save a personal Ethernet profile {profile} for user {user_id}.
        slots:
          profile: requestBody.profile
          user_id: path.collaborator.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}/{profile.profile_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's Ethernet profile
      effect: write
      questions:
      - How do I edit an Ethernet profile saved under my user account?
      - Can I change a personal Ethernet profile using a field mask?
      instructions:
      - text: Update Ethernet profile {profile_id} of user {user_id}.
        slots:
          profile_id: path.profile.profile_id
          user_id: path.collaborator.user_ids.user_id
      - text: Change user {user_id}'s Ethernet profile {profile_id} to {profile}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          profile_id: path.profile.profile_id
          profile: requestBody.profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's Ethernet profile
      effect: read
      questions:
      - What's configured in an Ethernet profile saved under a user?
      - Can I look up one personal Ethernet profile by its profile ID?
      instructions:
      - text: Show Ethernet profile {profile_id} of user {user_id}.
        slots:
          profile_id: path.profile_id
          user_id: path.collaborator.user_ids.user_id
      - text: Get the {field_mask} of user {user_id}'s Ethernet profile {profile_id}.
        slots:
          field_mask: query.field_mask
          user_id: path.collaborator.user_ids.user_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gcs/gateways/profiles/ethernet/users/{collaborator.user_ids.user_id}/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's Ethernet profile
      effect: destructive
      questions:
      - How do I delete an Ethernet profile from my user account?
      - Can I remove a personal managed gateway Ethernet profile?
      instructions:
      - text: Delete Ethernet 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 Ethernet profile {profile_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'