The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server Organization Access API

11 actions 11 updates phrasing extends openapi/the-things-network-organization-access-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['/organizations/{organization_ids.organization_id}/api-keys'].get
$.paths['/organizations/{organization_ids.organization_id}/api-keys'].post
$.paths['/organizations/{organization_ids.organization_id}/api-keys/{api_key.id}'].put
$.paths['/organizations/{organization_ids.organization_id}/api-keys/{key_id}'].get
$.paths['/organizations/{organization_ids.organization_id}/api-keys/{key_id}'].delete
$.paths['/organizations/{organization_ids.organization_id}/collaborator/user/{collaborator.user_ids.user_id}'].get
$.paths['/organizations/{organization_ids.organization_id}/collaborators'].get
$.paths['/organizations/{organization_ids.organization_id}/collaborators'].put
$.paths['/organizations/{organization_ids.organization_id}/collaborators/user/{collaborator_ids.user_ids.user_id}'].delete
$.paths['/organizations/{organization_id}/rights'].get

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 — Identity Server Organization Access API
  version: 1.0.0
extends: openapi/the-things-network-organization-access-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/organizations/{organization_ids.organization_id}/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's API keys
      effect: read
      questions:
      - Which API keys have been issued for my organization?
      - Can I page through an organization's API keys in a set order?
      instructions:
      - text: List the API keys of organization {organization_id}.
        slots:
          organization_id: path.organization_ids.organization_id
      - text: Show the first {limit} API keys on organization {organization_id}.
        slots:
          limit: query.limit
          organization_id: path.organization_ids.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization API key
      effect: write
      questions:
      - How do I create an API key that can reach an organization and its applications and gateways?
      - Can I give an organization key an expiration date?
      instructions:
      - text: Create an API key named {name} for organization {organization_id}.
        slots:
          name: requestBody.name
          organization_id: path.organization_ids.organization_id
      - text: Create a key for organization {organization_id} with rights {rights}.
        slots:
          organization_id: path.organization_ids.organization_id
          rights: requestBody.rights
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/api-keys/{api_key.id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the rights of an organization API key
      effect: write
      questions:
      - Can I change the rights on an existing organization API key?
      - What happens when an organization key is updated to have no rights?
      instructions:
      - text: Update rights on key {key_id} of organization {organization_id}.
        slots:
          key_id: path.api_key.id
          organization_id: path.organization_ids.organization_id
      - text: Strip every right from key {key_id} on organization {organization_id} so it is deleted.
        slots:
          key_id: path.api_key.id
          organization_id: path.organization_ids.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/api-keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization API key
      effect: read
      questions:
      - What rights does a specific organization API key carry?
      - Can I look up one of my organization's keys by ID?
      instructions:
      - text: Show API key {key_id} of organization {organization_id}.
        slots:
          key_id: path.key_id
          organization_id: path.organization_ids.organization_id
      - text: Check the rights and expiry of organization {organization_id}'s key {key_id}.
        slots:
          organization_id: path.organization_ids.organization_id
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/api-keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization API key
      effect: destructive
      questions:
      - How do I revoke an API key issued for an organization?
      - Is removing an organization key permanent?
      instructions:
      - text: Delete API key {key_id} from organization {organization_id}.
        slots:
          key_id: path.key_id
          organization_id: path.organization_ids.organization_id
      - text: Revoke organization {organization_id}'s key {key_id} now.
        slots:
          organization_id: path.organization_ids.organization_id
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/collaborator/user/{collaborator.user_ids.user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a member's rights in an organization
      effect: read
      questions:
      - What rights does a particular user have in my organization?
      - Are pseudo-rights expanded when I check a member's organization rights?
      instructions:
      - text: Show the rights user {user_id} has in organization {organization_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          organization_id: path.organization_ids.organization_id
      - text: Check what member {user_id} may do in organization {organization_id}.
        slots:
          user_id: path.collaborator.user_ids.user_id
          organization_id: path.organization_ids.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's members
      effect: read
      questions:
      - Who are the members of my organization?
      - Can I page through an organization's collaborators?
      instructions:
      - text: List the members of organization {organization_id}.
        slots:
          organization_id: path.organization_ids.organization_id
      - text: Show organization {organization_id}'s members, {limit} per page.
        slots:
          organization_id: path.organization_ids.organization_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/collaborators'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a member or set their organization rights
      effect: write
      questions:
      - How do I add a user to my organization with specific rights?
      - Do organization members inherit access to the organization's applications and gateways?
      instructions:
      - text: Set member {collaborator} and their rights on organization {organization_id}.
        slots:
          collaborator: requestBody.collaborator
          organization_id: path.organization_ids.organization_id
      - text: Change {collaborator}'s rights in organization {organization_id}, or give none to remove them.
        slots:
          collaborator: requestBody.collaborator
          organization_id: path.organization_ids.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_ids.organization_id}/collaborators/user/{collaborator_ids.user_ids.user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an organization
      effect: destructive
      questions:
      - How do I remove a user from my organization?
      - Can I drop one member without affecting the rest of the organization?
      instructions:
      - text: Remove user {user_id} from organization {organization_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          organization_id: path.organization_ids.organization_id
      - text: Revoke user {user_id}'s membership of organization {organization_id}.
        slots:
          user_id: path.collaborator_ids.user_ids.user_id
          organization_id: path.organization_ids.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organization_id}/rights'].get
  update:
    x-apievangelist-phrasing:
      intent: List my rights on an organization
      effect: read
      questions:
      - What rights do my credentials give me on this organization?
      - Can I check what my key is allowed to do in an organization?
      instructions:
      - text: List the rights I hold on organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Check what my credentials may do in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-10-01'