# 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 Collection API
  version: 1.0.0
extends: openapi/lucid-collection-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: 8
- target: $.paths['/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List all data collections I can access
      effect: read
      questions:
      - Which data collections do I have access to in Lucid?
      - Can I page through my collections using a start and end range?
      instructions:
      - text: List all my data collections.
      - text: Get collections from {start} to {end}.
        slots:
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data collection in a data source
      effect: write
      questions:
      - How do I add a new collection with a schema to an existing data source?
      - What do I need to supply to create a collection?
      instructions:
      - text: Create collection {name} in data source {dataSource} with schema {schema} and properties {properties}.
        slots:
          name: requestBody.name
          dataSource: requestBody.dataSource
          schema: requestBody.schema
          properties: requestBody.properties
      - text: Add a {name} collection to data source {dataSource} using schema {schema}, properties {properties}.
        slots:
          name: requestBody.name
          dataSource: requestBody.dataSource
          schema: requestBody.schema
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections'].head
  update:
    x-apievangelist-phrasing:
      intent: Count the collections I can access
      effect: read
      questions:
      - How many data collections do I have access to?
      - Is there a quick way to get a total collection count without fetching them all?
      instructions:
      - text: Count my collections.
      - text: Tell me the total number of collections I can access.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one data collection
      effect: read
      questions:
      - What does a specific collection look like in Lucid?
      - Can I fetch a single collection by its ID?
      instructions:
      - text: Get collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show me the details of collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection and its items
      effect: destructive
      questions:
      - Does deleting a collection also remove its schema, items and metadata collections?
      - Will the data source survive if I delete one of its collections?
      instructions:
      - text: Delete collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Permanently remove collection {collectionId} and everything in it.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a collection or move its data source
      effect: write
      questions:
      - Can I rename a collection after it's been created?
      - Is it possible to point a collection at a different data source?
      instructions:
      - text: Rename collection {collectionId} to {name}.
        slots:
          collectionId: path.collectionId
          name: requestBody.name
      - text: Move collection {collectionId} to data source {dataSource}.
        slots:
          collectionId: path.collectionId
          dataSource: requestBody.dataSource
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List metadata collections of a collection
      effect: read
      questions:
      - Which metadata collections are attached to a given collection?
      - How can I find the metadata collections that hang off a parent collection?
      instructions:
      - text: List metadata collections on collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the metadata attached to collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a metadata collection to a collection
      effect: write
      questions:
      - How do I attach a metadata collection to an existing collection?
      - Can metadata collections be edited later once created?
      instructions:
      - text: Create metadata collection {name} of type {metadataType} on collection {collectionId} with schema {schema} and properties {properties}.
        slots:
          name: requestBody.name
          metadataType: requestBody.metadataType
          collectionId: path.collectionId
          schema: requestBody.schema
          properties: requestBody.properties
      - text: Attach {metadataType} metadata named {name} to collection {collectionId}, schema {schema}, properties {properties}.
        slots:
          metadataType: requestBody.metadataType
          name: requestBody.name
          collectionId: path.collectionId
          schema: requestBody.schema
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'