The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server O Auth Authorization…

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

$.info
$.paths['/users/{user_ids.user_id}/authorizations'].get
$.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}'].delete
$.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}/tokens'].get
$.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}/tokens/{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 — Identity Server O Auth Authorization…
  version: 1.0.0
extends: openapi/the-things-network-oauthauthorizationregistry-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: 4
- target: $.paths['/users/{user_ids.user_id}/authorizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth clients a user has authorized
      effect: read
      questions:
      - Which apps have I granted OAuth access to my account?
      - Can I page through a user's authorized OAuth clients?
      instructions:
      - text: List OAuth clients authorized by user {user_id}.
        slots:
          user_id: path.user_ids.user_id
      - text: Show page {page} of apps user {user_id} has authorized.
        slots:
          page: query.page
          user_id: path.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: De-authorize an OAuth client
      effect: destructive
      questions:
      - How do I revoke a third-party app's OAuth access to my account?
      - Can I de-authorize one OAuth client for a user?
      instructions:
      - text: De-authorize OAuth client {client_id} for user {user_id}.
        slots:
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      - text: Revoke client {client_id}'s authorization on account {user_id}.
        slots:
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth tokens issued to a client
      effect: read
      questions:
      - What access tokens has an OAuth client been issued on my behalf?
      - Can I see active tokens for one authorized app?
      instructions:
      - text: List access tokens issued to client {client_id} for user {user_id}.
        slots:
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      - text: Show {limit} tokens per page for client {client_id} on account {user_id}.
        slots:
          limit: query.limit
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_ids.user_id}/authorizations/{client_ids.client_id}/tokens/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Invalidate an OAuth access token
      effect: destructive
      questions:
      - How do I invalidate a single OAuth access token?
      - Can I kill one token without de-authorizing the whole client?
      instructions:
      - text: Invalidate token {token_id} of client {client_id} for user {user_id}.
        slots:
          token_id: path.id
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      - text: Delete access token {token_id} issued to {client_id} on account {user_id}.
        slots:
          token_id: path.id
          client_id: path.client_ids.client_id
          user_id: path.user_ids.user_id
      method: generated
      generated: '2026-09-26'