API Evangelist conversational phrasing for Web of Science API Expanded Search API

# 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 API Expanded Search API
  version: 1.0.0
extends: openapi/clarivate-search-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: 8
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Web of Science with a query string
      effect: read
      questions:
      - How do I run an advanced Web of Science query with a GET request and get a query ID back?
      - Can I limit a Web of Science search to papers published in a given date range?
      - Which database editions can I restrict an expanded search to?
      instructions:
      - text: Search Web of Science database {databaseId} for {usrQuery}.
        slots:
          databaseId: query.databaseId
          usrQuery: query.usrQuery
      - text: Run the query {usrQuery} against {databaseId} for records published in {publishTimeSpan}.
        slots:
          usrQuery: query.usrQuery
          databaseId: query.databaseId
          publishTimeSpan: query.publishTimeSpan
      - text: Search {databaseId} for {usrQuery} and return the first {count} hits sorted by {sortField}.
        slots:
          databaseId: query.databaseId
          usrQuery: query.usrQuery
          count: query.count
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a Web of Science search in a request body
      effect: read
      questions:
      - Can I send a long Web of Science query as a POST body instead of URL parameters?
      - What do I put in the body to search the Web of Science collection by POST?
      instructions:
      - text: POST a search of {databaseId} for {usrQuery}, returning {count} records starting at {firstRecord}.
        slots:
          databaseId: requestBody.databaseId
          usrQuery: requestBody.usrQuery
          count: requestBody.count
          firstRecord: requestBody.firstRecord
      - text: Submit the query {usrQuery} to {databaseId} in a POST body limited to edition {edition}, {count} records from {firstRecord}.
        slots:
          usrQuery: requestBody.usrQuery
          databaseId: requestBody.databaseId
          edition: requestBody.edition
          count: requestBody.count
          firstRecord: requestBody.firstRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/query/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through results of an earlier search
      effect: read
      questions:
      - How do I fetch the next page of records from a search I already ran, using its query ID?
      - Can I re-sort the records of a previous Web of Science query without searching again?
      instructions:
      - text: Get records for query ID {queryId}.
        slots:
          queryId: path.queryId
      - text: Fetch {count} more records from query {queryId} starting at record {firstRecord}.
        slots:
          count: query.count
          queryId: path.queryId
          firstRecord: query.firstRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/related'].get
  update:
    x-apievangelist-phrasing:
      intent: Find records related by shared references
      effect: read
      questions:
      - How do I find papers that share cited references with a given Web of Science record?
      - Can I get related records for an article along with the article itself?
      instructions:
      - text: Find records related to {uniqueId} in {databaseId}.
        slots:
          uniqueId: query.uniqueId
          databaseId: query.databaseId
      - text: List the top {count} records in {databaseId} that share references with {uniqueId}.
        slots:
          count: query.count
          databaseId: query.databaseId
          uniqueId: query.uniqueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/citing'].get
  update:
    x-apievangelist-phrasing:
      intent: Find articles that cite a record
      effect: read
      questions:
      - Who has cited this Web of Science Core Collection article?
      - Can I list the citing articles for a paper published within a certain time span?
      instructions:
      - text: Find articles in {databaseId} that cite {uniqueId}.
        slots:
          databaseId: query.databaseId
          uniqueId: query.uniqueId
      - text: List articles citing {uniqueId} in {databaseId} that were published in {publishTimeSpan}.
        slots:
          uniqueId: query.uniqueId
          databaseId: query.databaseId
          publishTimeSpan: query.publishTimeSpan
      method: generated
      generated: '2026-10-01'
- target: $.paths['/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List the references an article cites
      effect: read
      questions:
      - What references does a given Web of Science article cite in its bibliography?
      - Is there a way to page through a paper's cited reference list?
      instructions:
      - text: List the cited references of {uniqueId} in {databaseId}.
        slots:
          uniqueId: query.uniqueId
          databaseId: query.databaseId
      - text: Get {count} cited references from {uniqueId}'s bibliography in {databaseId}, starting at {firstRecord}.
        slots:
          count: query.count
          uniqueId: query.uniqueId
          databaseId: query.databaseId
          firstRecord: query.firstRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/category-context/{uniqueId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subject category context for a document
      effect: read
      questions:
      - Which subject categories do a document's citing and cited references fall into?
      - Can I see the ASCA category distribution around a single paper?
      instructions:
      - text: Get the category context for document {uniqueId}.
        slots:
          uniqueId: path.uniqueId
      - text: Show at most {maxCat} subject categories for the references around {uniqueId}.
        slots:
          maxCat: query.maxCat
          uniqueId: path.uniqueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/citation-report/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Build a citation report for a search
      effect: read
      questions:
      - How do I get a citation report for the result set of a search I ran?
      - Is there a size limit on result sets for Web of Science citation reports?
      instructions:
      - text: Get the citation report for query {queryId}.
        slots:
          queryId: path.queryId
      - text: Build a citation report for query {queryId} covering {startYear} to {endYear}.
        slots:
          queryId: path.queryId
          startYear: query.startYear
          endYear: query.endYear
      method: generated
      generated: '2026-10-01'