# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Intellectual Property (IP) Data IP Cases API
  version: 1.0.0
extends: openapi/clarivate-ip-cases-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['/caselaw/document/availability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check caselaw document availability
      effect: read
      questions:
      - How do I check whether specific caselaw documents are available and when they were last updated?
      - Can I find caselaw documents updated since a certain date?
      instructions:
      - text: Check availability of caselaw documents {GUIDS}.
        slots:
          GUIDS: requestBody.GUIDS
      - text: List caselaw documents updated since {since}.
        slots:
          since: requestBody.SINCE_LAST_UPDATED
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caselaw/document/json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several caselaw documents by GUID
      effect: read
      questions:
      - How do I retrieve multiple full caselaw documents at once?
      - Can I limit which fields come back when fetching a batch of court cases?
      instructions:
      - text: Fetch caselaw documents {GUIDS}.
        slots:
          GUIDS: requestBody.GUIDS
      - text: Get cases {GUIDS} returning only fields {FIELDS}.
        slots:
          GUIDS: requestBody.GUIDS
          FIELDS: requestBody.FIELDS
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caselaw/document/json/{binder_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one full caselaw document
      effect: read
      questions:
      - How do I pull the full text record of a single IP court case?
      - Can I look up one litigation document by its binder ID?
      instructions:
      - text: Get caselaw document {binder_id}.
        slots:
          binder_id: path.binder_id
      - text: Show the full court case record for binder {binder_id}.
        slots:
          binder_id: path.binder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/caselaw/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and aggregate IP caselaw
      effect: read
      questions:
      - How do I search IP litigation cases and group the results?
      - Can I page through caselaw search results with a limit and offset?
      - What aggregations can I run over patent court cases?
      instructions:
      - text: Search caselaw for {QUERY}.
        slots:
          QUERY: requestBody.QUERY
      - text: Search court cases matching {QUERY} grouped by {GROUPBY}, top {LIMIT}.
        slots:
          QUERY: requestBody.QUERY
          GROUPBY: requestBody.GROUPBY
          LIMIT: requestBody.LIMIT
      method: generated
      generated: '2026-09-26'