# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Web of Science™ Researcher Researchers API
  version: 1.0.0
extends: openapi/clarivate-researchers-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['/researchers'].get
  update:
    x-apievangelist-phrasing:
      intent: Search researcher profiles
      effect: read
      questions:
      - How do I search Web of Science researcher profiles?
      - Can I sort researcher search results by something other than relevance?
      instructions:
      - text: Search researchers matching {q}.
        slots:
          q: query.q
      - text: Find researchers for {q} sorted by {sort} {sortOrder}.
        slots:
          q: query.q
          sort: query.sort
          sortOrder: query.sortOrder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/researchers/{rid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a researcher profile
      effect: read
      questions:
      - How do I get metrics and metadata for one researcher by ResearcherID?
      - What is in a researcher's Web of Science profile?
      instructions:
      - text: Get researcher {rid}.
        slots:
          rid: path.rid
      - text: Show profile metrics for ResearcherID {rid}.
        slots:
          rid: path.rid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/researchers/{rid}/peer-reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List a researcher's peer reviews
      effect: read
      questions:
      - Which peer reviews has a researcher done?
      - Can I filter a researcher's peer reviews by review type?
      instructions:
      - text: List peer reviews by researcher {rid}.
        slots:
          rid: path.rid
      - text: Show {reviewType} peer reviews for {rid}, page {page}.
        slots:
          reviewType: query.reviewType
          rid: path.rid
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/researchers/{rid}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a researcher's publications
      effect: read
      questions:
      - What documents has a researcher published?
      - Can I include non-indexed publications in a researcher's document list?
      instructions:
      - text: List documents published by researcher {rid}.
        slots:
          rid: path.rid
      - text: 'Get publications of {rid} in collections {collections}, including non-indexed: {nonIndexed}.'
        slots:
          rid: path.rid
          collections: query.collections
          nonIndexed: query.nonIndexed
      method: generated
      generated: '2026-10-01'