AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd System API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/health'].get
$.paths['/auth-health'].get
$.paths['/auth-capabilities'].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 Aiapplyd System API
  version: 1.0.0
extends: openapi/aiapplyd-system-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['/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the service is up
      effect: read
      questions:
      - Is the API up right now?
      - Can I ping the service without logging in?
      instructions:
      - text: Run a public health check.
      - text: Ping the API to confirm it's online.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my session and plan limits
      effect: read
      questions:
      - Is my login session valid, and what plan limits apply to me?
      - Which account does my current token belong to?
      instructions:
      - text: Run an authenticated health check and show my plan limits.
      - text: Confirm my session works and who I'm signed in as.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth-capabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: See which sign-in methods are available
      effect: read
      questions:
      - Which sign-in options can this deployment actually complete?
      - Is Google or magic-link sign-in enabled before I show a login button?
      instructions:
      - text: List the available sign-in methods.
      - text: Check which login options are enabled.
      method: generated
      generated: '2026-09-26'