# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Metadata API
  version: 1.0.0
extends: openapi/iterable-metadata-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['/api/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List metadata tables
      effect: read
      questions:
      - What metadata tables exist in my project?
      - Can I see all the key-value tables I've stored?
      instructions:
      - text: List my metadata tables.
      - text: Show every available metadata table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/{table}'].get
  update:
    x-apievangelist-phrasing:
      intent: List keys in a metadata table with paging
      effect: read
      questions:
      - Can I page through the keys of a metadata table with a marker?
      - Which keys are stored in a given table under /api/metadata?
      instructions:
      - text: List keys in metadata table {table}.
        slots:
          table: path.table
      - text: Continue listing table {table} keys from marker {nextMarker}.
        slots:
          table: path.table
          nextMarker: query.nextMarker
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/{table}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a metadata table asynchronously
      effect: destructive
      questions:
      - Is a metadata table deleted immediately or processed later?
      - Can I delete a whole table through /api/metadata?
      instructions:
      - text: Delete metadata table {table} via /api/metadata.
        slots:
          table: path.table
      - text: Asynchronously drop table {table}.
        slots:
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/{table}/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metadata key's value
      effect: read
      questions:
      - How do I read the value stored under a key in a metadata table?
      - Can I fetch a single /api/metadata entry by table and key?
      instructions:
      - text: Get the value of key {key} in table {table}.
        slots:
          key: path.key
          table: path.table
      - text: Read /api/metadata entry {key} from {table}.
        slots:
          key: path.key
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/{table}/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a metadata value
      effect: write
      questions:
      - Can I overwrite the value of a key in a metadata table?
      - Are metadata writes applied immediately?
      instructions:
      - text: Set key {key} in table {table} to {value}.
        slots:
          key: path.key
          table: path.table
          value: requestBody.value
      - text: Replace /api/metadata {table}/{key} with {value}.
        slots:
          table: path.table
          key: path.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metadata/{table}/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one metadata key asynchronously
      effect: destructive
      questions:
      - Can I delete just one key from a metadata table without dropping the table?
      - Does removing a metadata key take effect right away?
      instructions:
      - text: Delete key {key} from metadata table {table}.
        slots:
          key: path.key
          table: path.table
      - text: Asynchronously remove /api/metadata {table}/{key}.
        slots:
          table: path.table
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadata/{table}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all keys in a table (simple)
      effect: read
      questions:
      - Is there a plain /metadata endpoint that returns every key in a table?
      - Which basic call lists a metadata table's keys without paging?
      instructions:
      - text: Get all keys in table {table} from the plain /metadata endpoint.
        slots:
          table: path.table
      - text: Dump the keys of metadata table {table} with the simple endpoint.
        slots:
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadata/{table}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a metadata table and entries (simple)
      effect: destructive
      questions:
      - Can I delete a metadata table and all its entries via the plain /metadata path?
      - Which basic call wipes an entire metadata table?
      instructions:
      - text: Delete table {table} and all entries using /metadata.
        slots:
          table: path.table
      - text: Wipe metadata table {table} with the simple endpoint.
        slots:
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadata/{table}/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a metadata entry (simple)
      effect: read
      questions:
      - Is there a basic /metadata call to read one entry by table and key?
      - Can I fetch a stored entry with the plain metadata path?
      instructions:
      - text: Get entry {key} from table {table} via the plain /metadata endpoint.
        slots:
          key: path.key
          table: path.table
      - text: Read metadata {table}/{key} with the simple endpoint.
        slots:
          table: path.table
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadata/{table}/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a metadata entry (simple)
      effect: write
      questions:
      - Can I upsert a metadata entry through the basic /metadata path?
      - Which simple call creates or updates a key's value?
      instructions:
      - text: Using /metadata, set {table}/{key} to {value}.
        slots:
          table: path.table
          key: path.key
          value: requestBody.value
      - text: Upsert entry {key} in table {table} with {value} via the simple endpoint.
        slots:
          key: path.key
          table: path.table
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadata/{table}/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a metadata entry (simple)
      effect: destructive
      questions:
      - Can I delete a single entry through the plain /metadata path?
      - Which basic call removes one key from a table?
      instructions:
      - text: Delete entry {key} from table {table} using /metadata.
        slots:
          key: path.key
          table: path.table
      - text: Remove metadata {table}/{key} with the simple endpoint.
        slots:
          table: path.table
          key: path.key
      method: generated
      generated: '2026-10-01'