Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Warehouse Websites API

10 actions 10 updates phrasing extends openapi/optimizely-warehouse-websites-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/WarehouseWebsites'].get
$.paths['/api/v1/admin/WarehouseWebsites'].post
$.paths['/api/v1/admin/WarehouseWebsites({id})'].get
$.paths['/api/v1/admin/WarehouseWebsites({id})'].put
$.paths['/api/v1/admin/WarehouseWebsites({id})'].delete
$.paths['/api/v1/admin/WarehouseWebsites({id})'].patch
$.paths['/api/v1/admin/WarehouseWebsites/Default.Default()'].get
$.paths['/api/v1/admin/warehousewebsites/delete'].delete
$.paths['/api/v1/admin/warehousewebsites({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑
# 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 Websites API
  version: 1.0.0
extends: openapi/optimizely-warehouse-websites-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/WarehouseWebsites'].get
  update:
    x-apievangelist-phrasing:
      intent: List warehouse-to-website assignments
      effect: read
      questions:
      - Which warehouses serve which websites in Optimizely Configured Commerce?
      - Can I filter the warehouse assignments to one website?
      instructions:
      - text: List all warehouse website assignments.
      - text: List warehouse websites matching {filter}, with count {count}.
        slots:
          filter: query.$filter
          count: query.$count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseWebsites'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a warehouse to a website
      effect: write
      questions:
      - How do I make a warehouse available to a specific website?
      - What do I need to link a warehouse and a website?
      instructions:
      - text: Assign warehouse {warehouseId} to website {websiteId}.
        slots:
          warehouseId: requestBody.warehouseId
          websiteId: requestBody.websiteId
      - text: Let website {websiteId} fulfil from warehouse {warehouseId}.
        slots:
          websiteId: requestBody.websiteId
          warehouseId: requestBody.warehouseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseWebsites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one warehouse website assignment
      effect: read
      questions:
      - How do I look up a single warehouse-website link by its ID?
      - Can I expand the warehouse on one assignment record?
      instructions:
      - text: Show warehouse website assignment {id}.
        slots:
          id: path.id
      - text: Fetch warehouse website {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseWebsites({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a warehouse website assignment
      effect: write
      questions:
      - Can I overwrite a warehouse-website link with a different pair?
      - What happens when I fully replace a warehouse website record?
      instructions:
      - text: Replace assignment {id} with warehouse {warehouseId} and website {websiteId}.
        slots:
          id: path.id
          warehouseId: requestBody.warehouseId
          websiteId: requestBody.websiteId
      - text: Overwrite the whole warehouse website record {id}, pointing it at website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseWebsites({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a warehouse from a website
      effect: destructive
      questions:
      - How do I stop a warehouse from serving a website?
      - Can I make removing a warehouse assignment conditional on an ETag?
      instructions:
      - text: Delete warehouse website assignment {id}.
        slots:
          id: path.id
      - text: Delete warehouse website {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/WarehouseWebsites({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a warehouse website assignment
      effect: write
      questions:
      - Can I switch just the warehouse on an existing website assignment?
      - Is a partial update possible on a warehouse website link?
      instructions:
      - text: Patch assignment {id} to use warehouse {warehouseId}.
        slots:
          id: path.id
          warehouseId: requestBody.warehouseId
      - text: Move warehouse website link {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WarehouseWebsites/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a warehouse website
      effect: read
      questions:
      - What defaults does the admin pre-fill for a new warehouse website assignment?
      - Where do I get a blank warehouse website template?
      instructions:
      - text: Get the default warehouse website template.
      - text: Show me the pre-filled defaults for a new warehouse assignment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/warehousewebsites/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete warehouse website assignments
      effect: destructive
      questions:
      - How do I remove many warehouse-website links in one request?
      - Can I bulk-delete warehouse website assignments by ID?
      instructions:
      - text: Bulk delete warehouse websites {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the warehouse assignments {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/warehousewebsites({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a warehouse website
      effect: read
      questions:
      - How can I read one custom property stored on a warehouse website assignment?
      - Can I select fields from a warehouse assignment's custom property?
      instructions:
      - text: Show custom property {custompropertyKey} on warehouse website {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Fetch warehouse assignment {key}'s custom property {custompropertyKey}, selecting {select}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
          select: query.$select
      method: generated
      generated: '2026-09-26'