Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Tasks API

6 actions 6 updates phrasing extends openapi/lightfield-tasks-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 6

$.info
$.paths['/v1/tasks/definitions'].get
$.paths['/v1/tasks'].get
$.paths['/v1/tasks'].post
$.paths['/v1/tasks/{id}'].get
$.paths['/v1/tasks/{id}'].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 Tasks API
  version: 1.0.0
extends: openapi/lightfield-tasks-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: 5
- target: $.paths['/v1/tasks/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for tasks
      effect: read
      questions:
      - What fields and relationships can a task have in Lightfield?
      - Which task statuses and fields should I know about before creating tasks?
      instructions:
      - text: Show me the field and relationship definitions for tasks.
      - text: Fetch the task schema.
      - text: Get task field definitions using API version {version}.
        slots:
          version: header.Lightfield-Version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks
      effect: read
      questions:
      - How do I page through all the tasks in my workspace?
      - Can I fetch tasks a batch at a time?
      instructions:
      - text: List my tasks.
      - text: List {limit} tasks starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and assign a task
      effect: write
      questions:
      - How do I create a to-do and assign it to a teammate?
      - Who is recorded as the creator if I don't specify one on a new task?
      instructions:
      - text: Create a task with title and status {fields} assigned via {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      - text: Assign a new task {fields} to the member in {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one task by ID
      effect: read
      questions:
      - How do I look up a single task when I have its ID?
      - Can I see the details of one specific task?
      instructions:
      - text: Get task {id}.
        slots:
          id: path.id
      - text: Show me task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tasks/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing task
      effect: write
      questions:
      - How do I mark an existing task done or change its status?
      - Can I reassign a task I already created?
      instructions:
      - text: Update task {id} with {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Reassign existing task {id} using {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'