DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Auth API

2 actions 2 updates phrasing extends openapi/doit-auth-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DoiT's API. It is a proposal applied on top of the contract, not a document DoiT publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/auth/v1/validate'].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 DoiT Auth API
  version: 1.0.0
extends: openapi/doit-auth-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: 1
- target: $.paths['/auth/v1/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which user an API key belongs to
      effect: read
      questions:
      - How can I confirm which email and domain my API key is authenticated as?
      - Is there a quick call to verify my DoiT API credentials work?
      instructions:
      - text: Validate my API key and tell me the email and domain it belongs to.
      - text: Check who the current API user is.
      method: generated
      generated: '2026-10-01'