The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server Email Validation Registry API

3 actions 3 updates phrasing extends openapi/the-things-network-emailvalidationregistry-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['/email/validation'].post
$.paths['/email/validation'].patch

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 Email Validation Registry API
  version: 1.0.0
extends: openapi/the-things-network-emailvalidationregistry-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['/email/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Request email address validation
      effect: write
      questions:
      - How do I get a new verification email for my user account?
      - Can I request validation of a user's email address?
      instructions:
      - text: Request email validation for user {user_id} at {email}.
        slots:
          user_id: requestBody.user_id
          email: requestBody.email
      - text: Resend the verification email to {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email/validation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Confirm an email address
      effect: write
      questions:
      - How do I confirm my email address with the token from the email?
      - What IDs do I need to finish email verification?
      instructions:
      - text: Confirm email validation {id} with token {token}.
        slots:
          id: requestBody.id
          token: requestBody.token
      - text: Verify my email address using token {token} for validation {id}.
        slots:
          token: requestBody.token
          id: requestBody.id
      method: generated
      generated: '2026-09-26'