API Evangelist conversational phrasing for Things Stack — Gateway Server Gateway Access API

# 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 Gateway Access API
  version: 1.0.0
extends: openapi/the-things-network-gatewayaccess-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: 12
- target: $.paths['/gateways/{gateway_ids.gateway_id}/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a gateway's API keys
      effect: read
      questions:
      - Which API keys exist for my gateway?
      - Can I sort or page through the API keys scoped to one gateway?
      instructions:
      - text: List the API keys for gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_ids.gateway_id
      - text: Show page {page} of API keys on gateway {gateway_id}, ordered by {order}.
        slots:
          page: query.page
          gateway_id: path.gateway_ids.gateway_id
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key for a gateway
      effect: write
      questions:
      - How do I create an API key that only works for one gateway?
      - Can I set an expiry date on a gateway API key when I create it?
      instructions:
      - text: Create an API key named {name} for gateway {gateway_id} with rights {rights}.
        slots:
          name: requestBody.name
          gateway_id: path.gateway_ids.gateway_id
          rights: requestBody.rights
      - text: Create a gateway key for {gateway_id} that expires at {expires_at}.
        slots:
          gateway_id: path.gateway_ids.gateway_id
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/api-keys/{api_key.id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the rights of a gateway API key
      effect: write
      questions:
      - How do I change what an existing gateway API key is allowed to do?
      - Can I revoke a gateway API key by removing all of its rights?
      instructions:
      - text: Update API key {key_id} on gateway {gateway_id} with {api_key}.
        slots:
          key_id: path.api_key.id
          gateway_id: path.gateway_ids.gateway_id
          api_key: requestBody.api_key
      - text: Change only the fields {field_mask} of key {key_id} on gateway {gateway_id}.
        slots:
          field_mask: requestBody.field_mask
          key_id: path.api_key.id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/api-keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API key of a gateway
      effect: read
      questions:
      - What rights does a specific API key on my gateway have?
      - Can I look up a single gateway API key by its key ID?
      instructions:
      - text: Show API key {key_id} of gateway {gateway_id}.
        slots:
          key_id: path.key_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Check which rights gateway key {key_id} grants on {gateway_id}.
        slots:
          key_id: path.key_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/api-keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gateway API key
      effect: destructive
      questions:
      - How do I delete an API key from my gateway outright?
      - Can I remove a leaked gateway key by its ID?
      instructions:
      - text: Delete API key {key_id} from gateway {gateway_id}.
        slots:
          key_id: path.key_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Permanently remove gateway {gateway_id}'s key {key_id}.
        slots:
          key_id: path.key_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborator/organization/{collaborator.organization_ids.organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's rights on a gateway
      effect: read
      questions:
      - What rights does an organization have as a collaborator on my gateway?
      - Are pseudo-rights like _ALL expanded when I check an organization collaborator?
      instructions:
      - text: Show the rights organization {organization_id} has on gateway {gateway_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Check whether organization {organization_id} is a collaborator on gateway {gateway_id}.
        slots:
          organization_id: path.collaborator.organization_ids.organization_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborator/user/{collaborator.user_ids.user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's rights on a gateway
      effect: read
      questions:
      - What rights does a particular user have on my gateway?
      - Can I check one user collaborator's gateway permissions?
      instructions:
      - text: Show the rights user {user_id} has on gateway {gateway_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Check what user {user_id} is allowed to do as a member of gateway {gateway_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List a gateway's collaborators
      effect: read
      questions:
      - Who has access to my gateway as a collaborator?
      - Can I page through every member of a gateway?
      instructions:
      - text: List the collaborators on gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_ids.gateway_id
      - text: Show {limit} collaborators per page for gateway {gateway_id}.
        slots:
          limit: query.limit
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborators'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or change a gateway collaborator
      effect: write
      questions:
      - How do I add a teammate to my gateway with specific rights?
      - Can I change a gateway member's rights, or remove them by giving no rights?
      instructions:
      - text: Set collaborator {collaborator} on gateway {gateway_id}.
        slots:
          collaborator: requestBody.collaborator
          gateway_id: path.gateway_ids.gateway_id
      - text: Grant rights to a new collaborator {collaborator} on gateway {gateway_id}.
        slots:
          collaborator: requestBody.collaborator
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborators/organization/{collaborator_ids.organization_ids.organization_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization from a gateway
      effect: destructive
      questions:
      - How do I remove an organization's access to my gateway?
      - Can I revoke an organization collaborator on a gateway in one call?
      instructions:
      - text: Remove organization {organization_id} as a collaborator on gateway {gateway_id}.
        slots:
          organization_id: path.collaborator_ids.organization_ids.organization_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Revoke all gateway {gateway_id} access for organization {organization_id}.
        slots:
          organization_id: path.collaborator_ids.organization_ids.organization_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_ids.gateway_id}/collaborators/user/{collaborator_ids.user_ids.user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a gateway
      effect: destructive
      questions:
      - How do I kick a user off my gateway?
      - Can I remove a single user collaborator from a gateway?
      instructions:
      - text: Remove user {user_id} from gateway {gateway_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          gateway_id: path.gateway_ids.gateway_id
      - text: Revoke user {user_id}'s collaborator access to gateway {gateway_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          gateway_id: path.gateway_ids.gateway_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateways/{gateway_id}/rights'].get
  update:
    x-apievangelist-phrasing:
      intent: List my rights on a gateway
      effect: read
      questions:
      - What am I, the caller, allowed to do on this gateway?
      - Which rights does my current key or login have for a gateway?
      instructions:
      - text: List my own rights on gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      - text: Check which permissions my credentials have for gateway {gateway_id}.
        slots:
          gateway_id: path.gateway_id
      method: generated
      generated: '2026-09-26'