The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server Contact Info Registry API

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

$.info

$.paths['/contact_info/validation'].post

$.paths['/contact_info/validation'].patch

OpenAPI Overlay

# 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 Contact Info Registry API
  version: 1.0.0
extends: openapi/the-things-network-contactinforegistry-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: 2
- target: $.paths['/contact_info/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Request contact info validation for an entity
      effect: write
      questions:
      - How do I resend the validation email for an entity's contact info?
      - Can I request validation for an application's or gateway's contact details?
      instructions:
      - text: Request contact info validation for application {application_ids}.
        slots:
          application_ids: requestBody.application_ids
      - text: Send validation for the unvalidated contact info of gateway {gateway_ids}.
        slots:
          gateway_ids: requestBody.gateway_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contact_info/validation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Confirm a contact info validation
      effect: write
      questions:
      - How do I confirm contact info using the validation token I received?
      - What do I need to complete an entity contact info validation?
      instructions:
      - text: Confirm contact info validation {id} with token {token}.
        slots:
          id: requestBody.id
          token: requestBody.token
      - text: Validate entity contact info using validation {id} and token {token}.
        slots:
          id: requestBody.id
          token: requestBody.token
      method: generated
      generated: '2026-09-26'