# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Converis Web Services Data - Entity API
  version: 1.0.0
extends: openapi/clarivate-data-entity-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['/data/entities/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List all records of an entity type
      effect: read
      questions:
      - How do I export all records of one entity type, like publications, from Converis?
      - Can I sort and page through every object of an entity type?
      instructions:
      - text: List all {type} records.
        slots:
          type: path.type
      - text: List {count} {type} records sorted by {sort} from record {startRecord}.
        slots:
          count: query.count
          type: path.type
          sort: query.sort
          startRecord: query.startRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/entities/{type}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query entity records with a filter
      effect: read
      questions:
      - Can I filter Converis entity records by sending a query in the request body?
      - How do I get only the records of a type that match my criteria?
      instructions:
      - text: Query {type} records with a POST filter.
        slots:
          type: path.type
      - text: Run a filtered query on {type} records and return values in {language}.
        slots:
          type: path.type
          language: query.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/entities/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity record
      effect: read
      questions:
      - How do I read a single Converis object by its type and ID?
      - Can I get one record's attribute values in another language?
      instructions:
      - text: Get {type} record {id}.
        slots:
          type: path.type
          id: path.id
      - text: Fetch {type} object {id} with values in {language}.
        slots:
          type: path.type
          id: path.id
          language: query.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/entities/{type}/linked/{link_type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records linked to an object
      effect: read
      questions:
      - How do I find all entities of one type linked to a specific Converis object?
      - Can I list the persons linked to a publication through a given link type?
      instructions:
      - text: List {type} records linked via {link_type} to object {id}.
        slots:
          type: path.type
          link_type: path.link_type
          id: path.id
      - text: Get {type} entities connected through {link_type} to {id} in direction {direction}.
        slots:
          type: path.type
          link_type: path.link_type
          id: path.id
          direction: query.direction
      method: generated
      generated: '2026-10-01'