DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Ava API

5 actions 5 updates phrasing extends openapi/doit-ava-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 5

$.info
$.paths['/ava/v1/ask'].post
$.paths['/ava/v1/askSync'].post
$.paths['/ava/v1/feedback'].post
$.paths['/ava/v1/deleteConversation'].delete

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 Ava API
  version: 1.0.0
extends: openapi/doit-ava-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: 4
- target: $.paths['/ava/v1/ask'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask Ava with a streamed answer
      effect: read
      questions:
      - Can I stream Ava's answer as it is generated?
      - How do I get Ava's response over server-sent events?
      instructions:
      - text: Ask Ava {question} and stream the answer.
        slots:
          question: requestBody.question
      - text: Stream Ava's reply to {question} in conversation {conversationId}.
        slots:
          question: requestBody.question
          conversationId: requestBody.conversationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ava/v1/askSync'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask Ava and wait for the full answer
      effect: read
      questions:
      - How do I ask Ava a question and get one complete response back?
      - Can I ask Ava something without saving the conversation?
      instructions:
      - text: Ask Ava {question} and return the whole answer at once.
        slots:
          question: requestBody.question
      - text: Ask Ava {question} without persisting it (ephemeral {ephemeral}).
        slots:
          question: requestBody.question
          ephemeral: requestBody.ephemeral
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ava/v1/feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate an Ava answer
      effect: write
      questions:
      - How do I tell DoiT whether an Ava answer was helpful?
      - Can I leave feedback on a specific answer?
      instructions:
      - text: Send feedback {feedback} on answer {answerId} in conversation {conversationId}.
        slots:
          feedback: requestBody.feedback
          answerId: requestBody.answerId
          conversationId: requestBody.conversationId
      - text: Rate Ava answer {answerId} from conversation {conversationId} as {feedback}.
        slots:
          feedback: requestBody.feedback
          answerId: requestBody.answerId
          conversationId: requestBody.conversationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ava/v1/deleteConversation'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Ava conversation
      effect: destructive
      questions:
      - How do I delete a conversation I had with Ava?
      - Can I remove my Ava chat history?
      instructions:
      - text: Delete Ava conversation {conversationId}.
        slots:
          conversationId: query.conversationId
      - text: Remove conversation {conversationId} from Ava.
        slots:
          conversationId: query.conversationId
      method: generated
      generated: '2026-10-01'