Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Emails API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/emails/{id}'].get
$.paths['/v1/emails'].get
$.paths['/v1/emails/send'].post
$.paths['/v1/emails/draft'].post

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 Reference Emails API
  version: 1.0.0
extends: openapi/lightfield-emails-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['/v1/emails/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one email including its body
      effect: read
      questions:
      - How do I read the full body of a specific email?
      - Why might parts of an email I fetch by ID come back redacted?
      instructions:
      - text: Get email {id} with its message body.
        slots:
          id: path.id
      - text: Open email {id} and show my access level for it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List emails
      effect: read
      questions:
      - How can I page through the emails synced into my workspace?
      - Why don't email bodies appear when I browse the email list?
      instructions:
      - text: List my emails.
      - text: List {limit} emails starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/emails/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a new email
      effect: write
      questions:
      - Can I send an email from my connected mailbox through Lightfield?
      - Does sending support replies or forwards, or only brand-new messages?
      instructions:
      - text: Send an email from {from} to {to} with subject {subject} and body {messageBody}.
        slots:
          from: requestBody.from
          to: requestBody.to
          subject: requestBody.subject
          messageBody: requestBody.messageBody
      - text: Send {subject} from {from} to {to}, cc {cc}, saying {messageBody}.
        slots:
          subject: requestBody.subject
          from: requestBody.from
          to: requestBody.to
          cc: requestBody.cc
          messageBody: requestBody.messageBody
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/emails/draft'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an email as a draft
      effect: write
      questions:
      - Can I prepare an email as a draft without sending it?
      - What is the least I need to fill in to save an email draft?
      instructions:
      - text: Save a draft from {from} to {to} with subject {subject}.
        slots:
          from: requestBody.from
          to: requestBody.to
          subject: requestBody.subject
      - text: Draft (don't send) an email from {from} with body {messageBody}.
        slots:
          from: requestBody.from
          messageBody: requestBody.messageBody
      method: generated
      generated: '2026-10-01'