# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Search Boosts API
  version: 1.0.0
extends: openapi/optimizely-search-boosts-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: 9
- target: $.paths['/api/v1/admin/SearchBoosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List search boost rules
      effect: read
      questions:
      - Which search boosts are configured for my Optimizely Configured Commerce storefront?
      - Can I filter search boosts by entity type?
      instructions:
      - text: List all search boosts.
      - text: List search boosts matching {filter}, sorted by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a search boost
      effect: write
      questions:
      - How do I boost certain results for a search query?
      - Can I set the boost value and analyzers when creating a search boost?
      instructions:
      - text: Create a search boost for {entityType} on query {query}, shown as {queryDisplayName}, described as {description}.
        slots:
          entityType: requestBody.entityType
          query: requestBody.query
          queryDisplayName: requestBody.queryDisplayName
          description: requestBody.description
      - text: Add a boost on query {query} with value {value}.
        slots:
          query: requestBody.query
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one search boost
      effect: read
      questions:
      - How do I look up a single search boost's query and value by ID?
      - Can I choose which search boost fields come back?
      instructions:
      - text: Show search boost {id}.
        slots:
          id: path.id
      - text: Fetch search boost {id}, selecting {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a search boost
      effect: write
      questions:
      - Can I overwrite a search boost with a completely new rule?
      - What happens to search boost fields I leave out on a full replace?
      instructions:
      - text: Replace search boost {id} with entity type {entityType} and query {query}.
        slots:
          id: path.id
          entityType: requestBody.entityType
          query: requestBody.query
      - text: Overwrite the whole search boost {id}, setting its description to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search boost
      effect: destructive
      questions:
      - How do I remove one search boost by its ID?
      - Can I make deleting a search boost conditional on an ETag?
      instructions:
      - text: Delete search boost {id}.
        slots:
          id: path.id
      - text: Delete search boost {id} only if its ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a search boost
      effect: write
      questions:
      - Can I change just the boost value on an existing rule?
      - How would I make a search boost queryable or change its analyzer?
      instructions:
      - text: Patch search boost {id} so its value is {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Set search boost {id} queryable to {isQueryable} with query analyzer {queryAnalyzer}.
        slots:
          id: path.id
          isQueryable: requestBody.isQueryable
          queryAnalyzer: requestBody.queryAnalyzer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchBoosts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a search boost
      effect: read
      questions:
      - What defaults does the admin pre-fill for a new search boost?
      - Where do I get a blank search boost template?
      instructions:
      - text: Get the default search boost template.
      - text: Show me the pre-filled defaults for a new search boost.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchboosts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete search boosts
      effect: destructive
      questions:
      - How do I delete several search boosts in one request?
      - Can I bulk-remove search boosts by ID?
      instructions:
      - text: Bulk delete search boosts {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the search boosts with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchboosts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a search boost
      effect: read
      questions:
      - How can I read one custom property stored on a search boost?
      - Can I select fields from a search boost's custom property?
      instructions:
      - text: Show custom property {custompropertyKey} on search boost {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Fetch search boost {key}'s custom property {custompropertyKey}, selecting {select}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
          select: query.$select
      method: generated
      generated: '2026-09-26'