The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server User Invitation Registry API

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

$.info
$.paths['/invitations'].get
$.paths['/invitations'].post
$.paths['/invitations'].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 User Invitation Registry API
  version: 1.0.0
extends: openapi/the-things-network-userinvitationregistry-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: 3
- target: $.paths['/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List invitations I have sent
      effect: read
      questions:
      - Which network invitations have I sent that are still outstanding?
      - Can I page through my sent user invitations?
      instructions:
      - text: List the invitations I have sent.
      - text: Show my sent invitations, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to join the network
      effect: write
      questions:
      - How do I invite a new person to join The Things Stack network by email?
      - Can I send a network invitation to an email address that has no account yet?
      instructions:
      - text: Invite {email} to join the network.
        slots:
          email: requestBody.email
      - text: Send a network invitation to {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invitations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user invitation
      effect: destructive
      questions:
      - How do I cancel an invitation I sent by mistake?
      - Can I revoke a pending invitation to an email address?
      instructions:
      - text: Revoke the invitation sent to {email}.
        slots:
          email: query.email
      - text: Cancel the pending network invite for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'