AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Star Stories API

8 actions 8 updates phrasing extends openapi/aiapplyd-star-stories-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 8

$.info
$.paths['/star-stories'].get
$.paths['/star-stories'].post
$.paths['/star-stories/draft'].post
$.paths['/star-stories/generate-from-resume'].post
$.paths['/star-stories/extract-from-interview-prep/{jobId}'].post
$.paths['/star-stories/{id}'].delete
$.paths['/star-stories/{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 Star Stories API
  version: 1.0.0
extends: openapi/aiapplyd-star-stories-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: 7
- target: $.paths['/star-stories'].get
  update:
    x-apievangelist-phrasing:
      intent: List my STAR interview stories
      effect: read
      questions:
      - Which STAR stories have I saved for interviews?
      - Can I filter my story bank by theme like leadership?
      instructions:
      - text: List my STAR stories.
      - text: Show my STAR stories with theme {theme}.
        slots:
          theme: query.theme
      - text: Search my story bank for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a STAR story to my bank
      effect: write
      questions:
      - How do I save a STAR story I wrote myself for reuse in interviews?
      - Can I note which interview questions a story is best for?
      instructions:
      - text: 'Save a STAR story titled {title} on {theme}: situation {situation}, task {task}, action {action}, result {result}.'
        slots:
          title: requestBody.title
          theme: requestBody.theme
          situation: requestBody.situation
          task: requestBody.task
          action: requestBody.action
          result: requestBody.result
      - text: Add a {theme} story {title} with S {situation}, T {task}, A {action}, R {result}, best for {bestForQuestions}.
        slots:
          theme: requestBody.theme
          title: requestBody.title
          situation: requestBody.situation
          task: requestBody.task
          action: requestBody.action
          result: requestBody.result
          bestForQuestions: requestBody.bestForQuestions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories/draft'].post
  update:
    x-apievangelist-phrasing:
      intent: AI-draft a STAR story for an interview question
      effect: write
      questions:
      - Can AI draft a STAR answer to a specific interview question from my resume?
      - Will a drafted story be published without my review?
      instructions:
      - text: Draft a STAR story for the question {question}.
        slots:
          question: requestBody.question
      - text: 'Draft and save a STAR answer to {question}: {persist}.'
        slots:
          question: requestBody.question
          persist: requestBody.persist
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories/generate-from-resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate STAR stories from my resume
      effect: write
      questions:
      - Can I generate a set of STAR stories from my resume in one click?
      - What does it use to write stories when I haven't given a question?
      instructions:
      - text: Generate STAR stories from my resume.
      - text: Fill my story bank with stories from my resume and proof points.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories/extract-from-interview-prep/{jobId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract new STAR stories from interview prep
      effect: read
      questions:
      - Which stories from my interview prep for a job aren't in my bank yet?
      - Can I pull reusable stories out of a job's interview prep?
      instructions:
      - text: Extract STAR stories from the interview prep for job {jobId}.
        slots:
          jobId: path.jobId
      - text: Find new stories in job {jobId}'s prep to save.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a STAR story
      effect: destructive
      questions:
      - Can I permanently remove a story from my bank?
      - Is there an undo after deleting a STAR story?
      instructions:
      - text: Delete STAR story {id}.
        slots:
          id: path.id
      - text: Remove story {id} from my bank.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/star-stories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a STAR story
      effect: write
      questions:
      - How do I change the result section of a saved STAR story?
      - Can I retitle or re-theme a story in my bank?
      instructions:
      - text: Update STAR story {id} with result {result}.
        slots:
          id: path.id
          result: requestBody.result
      - text: Change the theme of story {id} to {theme}.
        slots:
          id: path.id
          theme: requestBody.theme
      method: generated
      generated: '2026-09-26'