AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Proof Points API

6 actions 6 updates phrasing extends openapi/aiapplyd-proof-points-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['/proof-points'].get
$.paths['/proof-points'].post
$.paths['/proof-points/suggest'].post
$.paths['/proof-points/{id}'].delete
$.paths['/proof-points/{id}'].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 Aiapplyd Proof Points API
  version: 1.0.0
extends: openapi/aiapplyd-proof-points-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['/proof-points'].get
  update:
    x-apievangelist-phrasing:
      intent: List my proof points
      effect: read
      questions:
      - What achievements do I have in my evidence bank?
      - Can I list proof points in one category, including archived ones?
      instructions:
      - text: List my proof points.
      - text: Show my proof points in category {category}.
        slots:
          category: query.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proof-points'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a proof point to my evidence bank
      effect: write
      questions:
      - How do I add an accomplishment with a headline metric to my evidence bank?
      - Is there a limit on how many proof points I can store?
      instructions:
      - text: Add a {category} proof point titled {title}.
        slots:
          category: requestBody.category
          title: requestBody.title
      - text: Create proof point {title} in {category} with hero metric {heroMetric}.
        slots:
          title: requestBody.title
          category: requestBody.category
          heroMetric: requestBody.heroMetric
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proof-points/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate proof points from my resume
      effect: write
      questions:
      - Can AI pull accomplishments out of my resume into my evidence bank?
      - Why might proof point suggestions come back empty?
      instructions:
      - text: Suggest proof points from my latest resume and add them.
      - text: Fill my evidence bank with achievements extracted from my resume.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proof-points/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a proof point
      effect: destructive
      questions:
      - Can I remove a proof point, and is it recoverable afterward?
      - How do I permanently drop one item from my evidence bank?
      instructions:
      - text: Delete proof point {id}.
        slots:
          id: path.id
      - text: Permanently remove {id} from my evidence bank.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proof-points/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a proof point
      effect: write
      questions:
      - How do I change the title or metric on an existing proof point?
      - Can I reorder proof points in my evidence bank?
      instructions:
      - text: Rename proof point {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Set the hero metric on proof point {id} to {heroMetric}.
        slots:
          id: path.id
          heroMetric: requestBody.heroMetric
      - text: Move proof point {id} to position {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-09-26'