# 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 - Link entity API
  version: 1.0.0
extends: openapi/clarivate-data-link-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/linkentities/{link_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List all entries of a link entity type
      effect: read
      questions:
      - How do I list every relationship record of one link type in Converis?
      - Can I sort and page through all entries of a link entity type?
      instructions:
      - text: List all {link_type} link entries.
        slots:
          link_type: path.link_type
      - text: List {count} {link_type} link entries sorted by {sort}, starting at {startRecord}.
        slots:
          count: query.count
          link_type: path.link_type
          sort: query.sort
          startRecord: query.startRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/linkentities/{link_type}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query link entity entries with a filter
      effect: read
      questions:
      - Can I filter Converis link entity entries by sending a query in the body?
      - How do I retrieve only the relationship records that match a query?
      instructions:
      - text: Query {link_type} link entries with a POST filter.
        slots:
          link_type: path.link_type
      - text: Run a filtered query on {link_type} links and return values in {language}.
        slots:
          link_type: path.link_type
          language: query.language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/linkentities/{link_type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link entity by type and ID
      effect: read
      questions:
      - How do I read one relationship record from Converis by its link type and ID?
      - Can I get link entity attribute values in a specific language?
      - Is it possible to include all attributes of a link entity instead of only the basic ones?
      instructions:
      - text: Get the {link_type} link entity with ID {id}.
        slots:
          link_type: path.link_type
          id: path.id
      - text: Fetch link entity {id} of type {link_type} with attribute values in {language}.
        slots:
          link_type: path.link_type
          id: path.id
          language: query.language
      - text: Read {link_type} link {id} including attributes {attributes}.
        slots:
          link_type: path.link_type
          id: path.id
          attributes: header.Converis-attribute-definition
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/linkentities/{link_type}/linked/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List link entries attached to an entity
      effect: read
      questions:
      - How do I find all relationship records that connect to a specific Converis entity?
      - Can I choose the direction when listing links attached to an object?
      instructions:
      - text: List {link_type} links attached to {type} {id}.
        slots:
          link_type: path.link_type
          type: path.type
          id: path.id
      - text: Get {link_type} links of {type} object {id} in direction {direction}.
        slots:
          link_type: path.link_type
          type: path.type
          id: path.id
          direction: query.direction
      method: generated
      generated: '2026-10-01'