Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Product Kit Section Options API

10 actions 10 updates phrasing extends openapi/optimizely-product-kit-section-options-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/ProductKitSectionOptions'].get
$.paths['/api/v1/admin/ProductKitSectionOptions'].post
$.paths['/api/v1/admin/ProductKitSectionOptions({id})'].get
$.paths['/api/v1/admin/ProductKitSectionOptions({id})'].put
$.paths['/api/v1/admin/ProductKitSectionOptions({id})'].delete
$.paths['/api/v1/admin/ProductKitSectionOptions({id})'].patch
$.paths['/api/v1/admin/ProductKitSectionOptions/Default.Default()'].get
$.paths['/api/v1/admin/productkitsectionoptions/delete'].delete
$.paths['/api/v1/admin/productkitsectionoptions({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 Product Kit Section Options API
  version: 1.0.0
extends: openapi/optimizely-product-kit-section-options-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/ProductKitSectionOptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List product kit section options
      effect: read
      questions:
      - What options can buyers choose within configurable product kit sections in Optimizely commerce?
      - Can I filter kit options to one kit section?
      instructions:
      - text: List all product kit section options.
      - text: List kit section options matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSectionOptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an option to a product kit section
      effect: write
      questions:
      - How do I add a selectable product option to a kit section?
      - Can a kit option use the product's own price instead of a custom one?
      instructions:
      - text: Add product {productId} as option {name} in kit section {productKitSectionId}.
        slots:
          productId: requestBody.productId
          name: requestBody.name
          productKitSectionId: requestBody.productKitSectionId
      - text: Create kit option {name} in section {productKitSectionId} priced at {price} with quantity {quantity}.
        slots:
          name: requestBody.name
          productKitSectionId: requestBody.productKitSectionId
          price: requestBody.price
          quantity: requestBody.quantity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSectionOptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product kit section option
      effect: read
      questions:
      - What price and quantity does a specific kit option have?
      - How do I fetch one kit section option by id?
      instructions:
      - text: Get kit section option {id}.
        slots:
          id: path.id
      - text: Show the price and default selection of kit option {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSectionOptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product kit section option
      effect: write
      questions:
      - How do I overwrite a kit option record entirely?
      - Can I replace every field of a kit section option at once?
      instructions:
      - text: Replace kit option {id} with product {productId}, name {name} and price {price}.
        slots:
          id: path.id
          productId: requestBody.productId
          name: requestBody.name
          price: requestBody.price
      - text: Fully overwrite kit section option {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSectionOptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product kit section option
      effect: destructive
      questions:
      - How do I remove an option from a product kit section?
      - Can I delete a kit option with an ETag check?
      instructions:
      - text: Delete kit section option {id}.
        slots:
          id: path.id
      - text: Delete kit option {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/ProductKitSectionOptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product kit section option
      effect: write
      questions:
      - How do I change the price of one kit option?
      - Can I make a kit option pre-selected by default?
      instructions:
      - text: Set kit option {id}'s price to {price}.
        slots:
          id: path.id
          price: requestBody.price
      - text: Set selected to {selected} on kit option {id}.
        slots:
          id: path.id
          selected: requestBody.selected
      - text: Move kit option {id} to sort position {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSectionOptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default kit section option
      effect: read
      questions:
      - What does an empty kit section option look like?
      - Is there a template for a new product kit option?
      instructions:
      - text: Get the default template for a new kit section option.
      - text: Show the blank product kit section option object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productkitsectionoptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several kit section options
      effect: destructive
      questions:
      - Can I delete multiple kit options in one request?
      - How do I bulk-remove product kit section options?
      instructions:
      - text: Delete kit section options {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove the kit options with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productkitsectionoptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a kit section option custom property
      effect: read
      questions:
      - How do I read a custom property on a kit section option?
      - Can kit options carry custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of kit option {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show kit section option {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'