# 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 Warehouse Alternates API
  version: 1.0.0
extends: openapi/optimizely-warehouse-alternates-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/WarehouseAlternates'].get
  update:
    x-apievangelist-phrasing:
      intent: List alternate warehouse pairings
      effect: read
      questions:
      - Which backup warehouses are configured in Optimizely Commerce?
      - Can I filter alternate warehouse pairings to one primary warehouse?
      instructions:
      - text: List all alternate warehouse pairings.
      - text: Show warehouse alternates matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a fallback warehouse for another
      effect: write
      questions:
      - How do I set up a backup warehouse to fulfill from when the primary is short?
      - What ids does linking a warehouse to its alternate need?
      instructions:
      - text: Make warehouse {alternateWarehouseId} an alternate for warehouse {warehouseId}.
        slots:
          alternateWarehouseId: requestBody.alternateWarehouseId
          warehouseId: requestBody.warehouseId
      - text: Add fallback warehouse {alternateWarehouseId} to {warehouseId}.
        slots:
          alternateWarehouseId: requestBody.alternateWarehouseId
          warehouseId: requestBody.warehouseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one alternate warehouse pairing
      effect: read
      questions:
      - Which warehouses does a given alternate pairing connect?
      - Can I look up one warehouse alternate record by id?
      instructions:
      - text: Fetch warehouse alternate {id}.
        slots:
          id: path.id
      - text: Show the primary and backup warehouse in pairing {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an alternate warehouse pairing
      effect: write
      questions:
      - Can I overwrite a warehouse alternate pairing in full?
      - Does replacing a pairing need both warehouse ids resent?
      instructions:
      - text: Replace warehouse alternate {id} with {warehouseId} backed by {alternateWarehouseId}.
        slots:
          id: path.id
          warehouseId: requestBody.warehouseId
          alternateWarehouseId: requestBody.alternateWarehouseId
      - text: Overwrite the full record of warehouse alternate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an alternate warehouse pairing
      effect: destructive
      questions:
      - How do I stop a warehouse from being used as another's backup?
      - Can removing a warehouse alternate be guarded by an ETag?
      instructions:
      - text: Delete warehouse alternate {id}.
        slots:
          id: path.id
      - text: Delete warehouse alternate {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Swap the backup in a warehouse pairing
      effect: write
      questions:
      - Can I swap which warehouse acts as the backup in an existing pairing?
      - Is it possible to change only the primary warehouse of a pairing?
      instructions:
      - text: Change the alternate in pairing {id} to warehouse {alternateWarehouseId}.
        slots:
          id: path.id
          alternateWarehouseId: requestBody.alternateWarehouseId
      - text: Set the primary warehouse of pairing {id} to {warehouseId}.
        slots:
          id: path.id
          warehouseId: requestBody.warehouseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseAlternates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a warehouse alternate
      effect: read
      questions:
      - What defaults does a new warehouse alternate start with?
      - Is there a blank warehouse pairing template?
      instructions:
      - text: Get the default field values for a new warehouse alternate.
      - text: Show the empty warehouse pairing template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/warehousealternates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete warehouse alternate pairings
      effect: destructive
      questions:
      - Can I remove many warehouse alternate pairings at once?
      - Is there a batch delete for warehouse alternates by id list?
      instructions:
      - text: Bulk delete warehouse alternates {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every warehouse pairing in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/warehousealternates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a warehouse alternate
      effect: read
      questions:
      - How can I read a custom property stored on a warehouse alternate?
      - Can I fetch one custom field value from a warehouse pairing?
      instructions:
      - text: Get custom property {custompropertyKey} of warehouse alternate {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on warehouse pairing {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'