# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Notes API
  version: 1.0.0
extends: openapi/lightfield-notes-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/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes
      effect: read
      questions:
      - How do I page through all the notes in my workspace?
      - Can I fetch notes a batch at a time?
      instructions:
      - text: List my notes.
      - text: List {limit} notes starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a new note
      effect: write
      questions:
      - How do I add a note to an account or opportunity?
      - Who is recorded as the author when I create a note through the API?
      instructions:
      - text: Create a note with {fields}.
        slots:
          fields: requestBody.fields
      - text: Write a note with {fields} and link it to {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one note by ID
      effect: read
      questions:
      - How do I read a single note when I have its ID?
      - Can I see the full content of one specific note?
      instructions:
      - text: Get note {id}.
        slots:
          id: path.id
      - text: Show me note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/notes/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a note or relink it
      effect: write
      questions:
      - How do I edit the text of a note I already wrote?
      - Can I add or remove the account or opportunity an existing note is attached to?
      instructions:
      - text: Update note {id} with {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Relink existing note {id} using {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'