AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Account API

6 actions 6 updates phrasing extends openapi/aiapplyd-account-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 6

$.info

$.paths['/account'].get

$.paths['/account'].put

$.paths['/account'].delete

$.paths['/account/export'].get

$.paths['/account/apple-authorization'].post

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 Aiapplyd Account API
  version: 1.0.0
extends: openapi/aiapplyd-account-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: 5
- target: $.paths['/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account details
      effect: read
      questions:
      - What name and phone number are on my account?
      - Where can I see my account's profile details?
      instructions:
      - text: Show my account details.
      - text: Get my account info.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my account details
      effect: write
      questions:
      - How do I change my name or phone number on my account?
      - Can I opt out of marketing emails from account settings?
      instructions:
      - text: Change my account name to {name}.
        slots:
          name: requestBody.name
      - text: Update my phone to {phone} and locale to {locale}.
        slots:
          phone: requestBody.phone
          locale: requestBody.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete my account permanently
      effect: destructive
      questions:
      - Can I delete my account and all of its data while signed in?
      - Is deleting my account reversible?
      instructions:
      - text: Delete my account permanently.
      - text: Erase my account and all associated data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an export of my account data
      effect: read
      questions:
      - Can I download a copy of all my data?
      - What does the account data export include?
      instructions:
      - text: Export my account data.
      - text: Download my data as JSON.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/apple-authorization'].post
  update:
    x-apievangelist-phrasing:
      intent: Store an Apple sign-in authorization
      effect: write
      questions:
      - What does the app store after I sign in with Apple?
      - How is my Apple authorization code linked to my account?
      instructions:
      - text: Store Apple authorization code {authorizationCode} for Apple user {appleUserId}.
        slots:
          authorizationCode: requestBody.authorizationCode
          appleUserId: requestBody.appleUserId
      - text: Link Apple sign-in {appleUserId} to my account using code {authorizationCode}.
        slots:
          appleUserId: requestBody.appleUserId
          authorizationCode: requestBody.authorizationCode
      method: generated
      generated: '2026-09-26'