API Evangelist conversational phrasing for Approvals Search Filters API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Approvals Search Filters API
  version: 1.0.0
extends: openapi/conga-search-filters-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: 7
- target: $.paths['/v1/search-filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved search filters
      effect: read
      questions:
      - How do I find my saved search filters by name?
      - Can I page through search filters with a limit?
      instructions:
      - text: List search filters matching {filter}.
        slots:
          filter: query.filter
      - text: Show page {page} of my saved search filters, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a search filter
      effect: write
      questions:
      - How do I save a new search filter?
      - Can I update an existing search filter by passing its ID?
      instructions:
      - text: Save a search filter for business object {BusinessObjectLabel}.
        slots:
          BusinessObjectLabel: requestBody.BusinessObjectLabel
      - text: Create a new saved search filter.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a search filter name is taken
      effect: read
      questions:
      - Is a search filter name already in use for this object type?
      - How do I check name availability before saving a filter?
      instructions:
      - text: Check whether filter name {name} is taken for {businessObjectType}.
        slots:
          name: query.name
          businessObjectType: query.businessObjectType
      - text: Validate the search filter name {name} on object type {businessObjectType}.
        slots:
          name: query.name
          businessObjectType: query.businessObjectType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a search filter
      effect: read
      questions:
      - How do I retrieve one saved search filter by ID?
      - What criteria does a specific search filter contain?
      instructions:
      - text: Get search filter {id}.
        slots:
          id: path.id
      - text: Show the criteria in saved filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search filter
      effect: destructive
      questions:
      - How do I delete a saved search filter?
      - Can I permanently remove a filter I no longer need?
      instructions:
      - text: Delete search filter {id}.
        slots:
          id: path.id
      - text: Permanently remove saved filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a search filter
      effect: write
      questions:
      - How do I turn a saved search filter back on?
      - Can I activate an inactive filter?
      instructions:
      - text: Activate search filter {id}.
        slots:
          id: path.id
      - text: Turn on saved filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search-filters/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a search filter
      effect: write
      questions:
      - How do I disable a search filter without deleting it?
      - Can I deactivate a filter temporarily?
      instructions:
      - text: Deactivate search filter {id}.
        slots:
          id: path.id
      - text: Switch off saved filter {id} but keep it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'