# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for APIs.io Saved Workspace API
  version: 1.0.0
extends: openapi/apis-io-saved-workspace-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: 10
- target: $.paths['/me/searches'].get
  update:
    x-apievangelist-phrasing:
      intent: List my saved searches
      effect: read
      questions:
      - What saved searches do I have?
      - Can I see all the searches stored under my key?
      instructions:
      - text: List my saved searches.
      - text: Show every search I have saved.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/searches'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a named search
      effect: write
      questions:
      - Can I save a search for payments providers above a score to rerun later?
      - How do I store a named search with tag and band filters?
      instructions:
      - text: Save a search named {name} for {q}.
        slots:
          name: requestBody.name
          q: requestBody.q
      - text: Create a saved search {name} for tags {tags} with minimum score {min_score}.
        slots:
          name: requestBody.name
          tags: requestBody.tags
          min_score: requestBody.min_score
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/searches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved search
      effect: destructive
      questions:
      - How do I delete a saved search I no longer need?
      - Does deleting a saved search also remove its delta cursor?
      instructions:
      - text: Delete saved search {id}.
        slots:
          id: path.id
      - text: Remove my saved search {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/searches/{id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Re-run a saved search
      effect: read
      questions:
      - Which providers currently match a search I saved?
      - Can I rerun a saved search against the live catalog?
      instructions:
      - text: Run saved search {id}.
        slots:
          id: path.id
      - text: Show up to {limit} current matches for saved search {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/searches/{id}/net_new'].get
  update:
    x-apievangelist-phrasing:
      intent: See what's new for a saved search
      effect: write
      questions:
      - What's new for my saved search since I last checked?
      - Which providers newly match my saved criteria?
      instructions:
      - text: Show net-new matches for saved search {id}.
        slots:
          id: path.id
      - text: Check what changed for saved search {id} since last time.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List my shortlists
      effect: read
      questions:
      - What shortlists do I own?
      - Can I see all my saved provider lists?
      instructions:
      - text: List my lists.
      - text: Show all the shortlists I own.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a named shortlist
      effect: write
      questions:
      - Can I create a shortlist of providers to track?
      - How do I start a named stack seeded with some providers?
      instructions:
      - text: Create a list named {name}.
        slots:
          name: requestBody.name
      - text: Create a list {name} seeded with {members}.
        slots:
          name: requestBody.name
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shortlist with current ratings
      effect: read
      questions:
      - What's on one of my lists, with current band and score?
      - Can I see a shortlist's members resolved to their current ratings?
      instructions:
      - text: Get list {id}.
        slots:
          id: path.id
      - text: Show the members of list {id} with their scores.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shortlist
      effect: destructive
      questions:
      - How do I delete a list I own?
      - Is deleting a shortlist permanent?
      instructions:
      - text: Delete list {id}.
        slots:
          id: path.id
      - text: Permanently remove my list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/lists/{id}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add providers or APIs to a shortlist
      effect: write
      questions:
      - Can I add more providers or APIs to an existing list?
      - Will adding a provider twice to a list create a duplicate?
      instructions:
      - text: Add {members} to list {id}.
        slots:
          members: requestBody.members
          id: path.id
      - text: Append providers {members} to my list {id}.
        slots:
          members: requestBody.members
          id: path.id
      method: generated
      generated: '2026-09-26'