# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Derwent Sequence Search Searches API
  version: 1.0.0
extends: openapi/clarivate-searches-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: 6
- target: $.paths['/reports/{report_id}/searches'].get
  update:
    x-apievangelist-phrasing:
      intent: List searches in a project
      effect: read
      questions:
      - How do I see all the sequence searches in one project?
      - Can I page through a project's searches?
      instructions:
      - text: List searches in project {report_id}.
        slots:
          report_id: path.report_id
      - text: Show page {page} of searches in project {report_id}, {limit} per page.
        slots:
          page: query.page
          report_id: path.report_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{report_id}/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a search in a project
      effect: write
      questions:
      - How do I add a generic sequence search to a project?
      - What is needed to create a new search inside a project?
      instructions:
      - text: Create a search in project {report_id}.
        slots:
          report_id: path.report_id
      - text: Add a new generic search to project {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{report_id}/searches/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a search in a project
      effect: read
      questions:
      - Where can I see the settings and status of one sequence search?
      - Can I look up a single search by ID inside a project?
      instructions:
      - text: Show search {id} in project {report_id}.
        slots:
          id: path.id
          report_id: path.report_id
      - text: Get the details of search {id} from project {report_id}.
        slots:
          id: path.id
          report_id: path.report_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{report_id}/searches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search from a project
      effect: destructive
      questions:
      - How do I remove one search from a project?
      - Can I delete a single sequence search without deleting its project?
      instructions:
      - text: Delete search {id} from project {report_id}.
        slots:
          id: path.id
          report_id: path.report_id
      - text: Remove the single search {id} in project {report_id}.
        slots:
          id: path.id
          report_id: path.report_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{report_id}/searches/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a search in a project
      effect: write
      questions:
      - How do I edit an existing sequence search?
      - Can I rename a search after creating it?
      instructions:
      - text: Update search {id} in project {report_id} with {search}.
        slots:
          id: path.id
          report_id: path.report_id
          search: requestBody.search
      - text: Change search {id} of project {report_id} to {search}.
        slots:
          id: path.id
          report_id: path.report_id
          search: requestBody.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{report_id}/searches/destroy_bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete searches in a project
      effect: destructive
      questions:
      - Can I delete many searches from a project at once?
      - How do I clean up several sequence searches in one call?
      instructions:
      - text: Bulk delete searches {ids} from project {report_id}.
        slots:
          ids: query.ids[]
          report_id: path.report_id
      - text: Destroy all of searches {ids} in project {report_id} at once.
        slots:
          ids: query.ids[]
          report_id: path.report_id
      method: generated
      generated: '2026-10-01'