API Evangelist conversational phrasing for Lucid Data Data Item API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lucid Data Data Item API
  version: 1.0.0
extends: openapi/lucid-data-item-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: 11
- target: $.paths['/collections/{collectionId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the data items in a collection
      effect: read
      questions:
      - What rows are stored in my Lucid data collection?
      - Can I page through every item in a collection a range at a time?
      - Is there a way to filter the items returned from a collection?
      instructions:
      - text: List all data items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show items {start} through {end} of collection {collectionId}.
        slots:
          start: query.start
          end: query.end
          collectionId: path.collectionId
      - text: Get the items in collection {collectionId} that match filter {filter}.
        slots:
          collectionId: path.collectionId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add new data items to a collection
      effect: write
      questions:
      - How do I insert new rows into a data collection?
      - Are fields that aren't in the collection schema kept when I add items?
      instructions:
      - text: Add new data items to collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Insert these rows as new items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several data items from a collection
      effect: destructive
      questions:
      - Can I remove a batch of specific items from a collection in one call?
      - Is deleting a list of data items reversible?
      instructions:
      - text: Delete items {items} from collection {collectionId}.
        slots:
          items: query.items
          collectionId: path.collectionId
      - text: Remove the listed data items {items} from collection {collectionId} permanently.
        slots:
          items: query.items
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update many data items in a collection at once
      effect: write
      questions:
      - How can I edit the field values of many collection items in one request?
      - Can I bulk-update rows I fetched from a collection?
      instructions:
      - text: Bulk update the items in collection {collectionId}, setting fields {fields} on item {uri}.
        slots:
          collectionId: path.collectionId
          fields: requestBody.fields
          uri: requestBody.uri
      - text: Apply my edited values to multiple items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items'].head
  update:
    x-apievangelist-phrasing:
      intent: Count the data items in a collection
      effect: read
      questions:
      - How many items does a data collection contain?
      - Can I get just the item total for a collection without downloading the rows?
      instructions:
      - text: Count the data items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Tell me the total number of rows in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items/{dataItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single data item
      effect: read
      questions:
      - What values does one particular item in a collection hold?
      - Can I fetch a single row from a collection by its item ID?
      instructions:
      - text: Get data item {dataItemId} from collection {collectionId}.
        slots:
          dataItemId: path.dataItemId
          collectionId: path.collectionId
      - text: Show me the field values of item {dataItemId} in collection {collectionId}.
        slots:
          dataItemId: path.dataItemId
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items/{dataItemId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Find data items by their key field values
      effect: read
      questions:
      - How do I look up collection items whose key fields equal certain values?
      - Can I match items by primary key values rather than by item ID?
      instructions:
      - text: Find items in collection {collectionId} whose key fields equal {targetValues}.
        slots:
          collectionId: path.collectionId
          targetValues: requestBody.targetValues
      - text: Look up items in collection {collectionId} matching {targetValues} on key fields {keySchemaFields}, starting from item {dataItemId}.
        slots:
          collectionId: path.collectionId
          targetValues: requestBody.targetValues
          keySchemaFields: requestBody.keySchemaFields
          dataItemId: path.dataItemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items/{dataItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one data item
      effect: destructive
      questions:
      - Can I permanently remove a single row from a collection?
      - What happens when I delete one data item, can it be recovered?
      instructions:
      - text: Delete data item {dataItemId} from collection {collectionId}.
        slots:
          dataItemId: path.dataItemId
          collectionId: path.collectionId
      - text: Remove the single item {dataItemId} in collection {collectionId}.
        slots:
          dataItemId: path.dataItemId
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/items/{dataItemId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one data item's values
      effect: write
      questions:
      - How do I change the values of one specific item in a collection?
      - Can I move a data item into a different collection when editing it?
      instructions:
      - text: Update data item {dataItemId} in collection {collectionId} with fields {fields}.
        slots:
          dataItemId: path.dataItemId
          collectionId: path.collectionId
          fields: requestBody.fields
      - text: Patch item {uri} in collection {collectionId} so its values change, for item ID {dataItemId}.
        slots:
          uri: requestBody.uri
          collectionId: path.collectionId
          dataItemId: path.dataItemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/itemsByKey'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete data items that match key values
      effect: destructive
      questions:
      - Can I delete every item whose key fields match given values?
      - Which items are removed when I delete by key rather than by ID?
      instructions:
      - text: Delete all items in collection {collectionId} whose keys match {targetValues}.
        slots:
          collectionId: path.collectionId
          targetValues: requestBody.targetValues
      - text: Remove items from collection {collectionId} matching {targetValues} on key fields {keySchemaFields}.
        slots:
          collectionId: path.collectionId
          targetValues: requestBody.targetValues
          keySchemaFields: requestBody.keySchemaFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/itemsByKey'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch data items matched by key values
      effect: write
      questions:
      - How do I update items by matching their key field values?
      - If I send a null value in a key-matched patch, does that field get cleared?
      instructions:
      - text: Apply patches {patches} to items in collection {collectionId} matched by key.
        slots:
          patches: requestBody.patches
          collectionId: path.collectionId
      - text: Update items in collection {collectionId} matched on key fields {keySchemaFields} using patches {patches}.
        slots:
          collectionId: path.collectionId
          keySchemaFields: requestBody.keySchemaFields
          patches: requestBody.patches
      method: generated
      generated: '2026-10-01'