# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Entities Generic API
  version: 1.0.0
extends: openapi/antavo-generic-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: 7
- target: $.paths['/entities/{module}/{entity}/{entity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve any entity item by its ID
      effect: read
      questions:
      - How do I fetch a single item from any Antavo entity module, including custom entities?
      - Can I look up one entity record by module, entity type and item ID?
      - What does the generic entity endpoint return for one specific entity item?
      instructions:
      - text: Get entity item {entity_id} of type {entity} in the {module} module.
        slots:
          entity_id: path.entity_id
          entity: path.entity
          module: path.module
      - text: Show me everything stored on custom entity {entity} item {entity_id} in module {module}.
        slots:
          entity: path.entity
          entity_id: path.entity_id
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{module}/{entity}/{entity_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an entity item with an ID you choose
      effect: write
      questions:
      - Can I create a generic entity item and assign my own ID to it instead of letting the system pick one?
      - Which attributes can I set when creating an entity item under a chosen ID?
      instructions:
      - text: Create a new {entity} item in the {module} module with the ID {entity_id}.
        slots:
          entity: path.entity
          module: path.module
          entity_id: path.entity_id
      - text: Add entity item {entity_id} to module {module} as type {entity}, using my own identifier.
        slots:
          entity_id: path.entity_id
          module: path.module
          entity: path.entity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{module}/{entity}/{entity_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update attributes on an existing entity item
      effect: write
      questions:
      - How do I change an attribute on an existing item in a generic or custom entity module?
      - Do I need the attribute's ID from the Management UI to modify an entity item?
      instructions:
      - text: Update the attributes of existing {entity} item {entity_id} in module {module}.
        slots:
          entity: path.entity
          entity_id: path.entity_id
          module: path.module
      - text: Modify a configured attribute on entity item {entity_id} ({entity}, module {module}).
        slots:
          entity_id: path.entity_id
          entity: path.entity
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{module}/{entity}/{entity_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a deactivated entity item
      effect: destructive
      questions:
      - Can I archive an inactive item from any entity module so it disappears from the Management UI?
      - What happens to a generic entity item once it is archived?
      instructions:
      - text: Archive deactivated {entity} item {entity_id} in the {module} module.
        slots:
          entity: path.entity
          entity_id: path.entity_id
          module: path.module
      - text: Remove inactive entity item {entity_id} of type {entity} from module {module} by archiving it.
        slots:
          entity_id: path.entity_id
          entity: path.entity
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{module}/{entity}'].get
  update:
    x-apievangelist-phrasing:
      intent: List all items of an entity type
      effect: read
      questions:
      - Can I list every item in a custom entity module?
      - Can I page through all items of an entity type without tying them to a customer?
      instructions:
      - text: List all {entity} items in module {module}.
        slots:
          entity: path.entity
          module: path.module
      - text: Show {limit} {entity} items from module {module}, starting at offset {offset}.
        slots:
          limit: query.limit
          entity: path.entity
          module: path.module
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{module}/{entity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an entity item with a system-assigned ID
      effect: write
      questions:
      - How do I add a new item to an entity module without specifying an ID myself?
      - Can I create a record in a custom entity module through a generic endpoint?
      instructions:
      - text: Create a new {entity} item in the {module} module and let the system assign its ID.
        slots:
          entity: path.entity
          module: path.module
      - text: Add a record of entity type {entity} to custom module {module}.
        slots:
          entity: path.entity
          module: path.module
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit entity changes in bulk
      effect: write
      questions:
      - Can I send many entity calls in a single request?
      - What error handling options exist when submitting entities in bulk?
      instructions:
      - text: 'Submit these entities in bulk: {entities}.'
        slots:
          entities: requestBody.entities
      - text: Bulk-submit {entities} with error handling mode {error_handling}.
        slots:
          entities: requestBody.entities
          error_handling: requestBody.error_handling
      method: generated
      generated: '2026-10-01'