# 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™ Starter Documents API
  version: 1.0.0
extends: openapi/clarivate-documents-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: 2
- target: $.paths['/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Web of Science documents
      effect: read
      questions:
      - How do I search Web of Science documents with the Starter API?
      - Can I filter documents by publication date and sort the results?
      instructions:
      - text: Search Web of Science documents for {q}.
        slots:
          q: query.q
      - text: Find documents matching {q} published in {publishTimeSpan}, sorted by {sortField}.
        slots:
          q: query.q
          publishTimeSpan: query.publishTimeSpan
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documents/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document by accession number
      effect: read
      questions:
      - How do I look up one Web of Science document by its UID?
      - Can I get full detail for a single accession number?
      instructions:
      - text: Get Web of Science document {uid}.
        slots:
          uid: path.uid
      - text: Fetch document {uid} with detail level {detail}.
        slots:
          uid: path.uid
          detail: query.detail
      method: generated
      generated: '2026-10-01'