# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Converis CUD Link Entities API
  version: 1.0.0
extends: openapi/clarivate-link-entities-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/{version}/dataobject/linkentities'].put
  update:
    x-apievangelist-phrasing:
      intent: Update existing Converis link entities
      effect: write
      questions:
      - How do I change existing relationships between records in Converis?
      - Can I update several link entities connecting persons and publications at once?
      instructions:
      - text: Update the existing link entities {entities} on API version {version}.
        slots:
          version: path.version
          entities: requestBody.entities
      - text: Modify these stored relationship links {entities} using version {version}.
        slots:
          version: path.version
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/linkentities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new Converis link entities
      effect: write
      questions:
      - How do I link a person to a publication in Converis through the API?
      - Can I create multiple new relationships between records in one request?
      instructions:
      - text: Create new link entities {entities} in Converis on API version {version}.
        slots:
          version: path.version
          entities: requestBody.entities
      - text: Add these new relationship links {entities} between records, version {version}.
        slots:
          version: path.version
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/linkentities'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete Converis link entities
      effect: destructive
      questions:
      - How do I remove a relationship between two Converis records?
      - Is there a way to unlink records in bulk in Converis?
      instructions:
      - text: Delete the specified link entities from Converis on API version {version}.
        slots:
          version: path.version
      - text: Remove relationship links between records via the CUD API, version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/linkentities'].options
  update:
    x-apievangelist-phrasing:
      intent: Describe supported link entity actions
      effect: read
      questions:
      - Which actions and request structure does the link entities endpoint accept?
      - What does a link entity payload need to contain before I create or update one?
      instructions:
      - text: Show the supported actions and request structure for link entities on version {version}.
        slots:
          version: path.version
      - text: Describe the allowed operations for the link entities endpoint, API version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'