Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Product Kit Sections API

11 actions 11 updates phrasing extends openapi/optimizely-product-kit-sections-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 11

$.info
$.paths['/api/v1/admin/ProductKitSections'].get
$.paths['/api/v1/admin/ProductKitSections'].post
$.paths['/api/v1/admin/ProductKitSections({id})'].get
$.paths['/api/v1/admin/ProductKitSections({id})'].put
$.paths['/api/v1/admin/ProductKitSections({id})'].delete
$.paths['/api/v1/admin/ProductKitSections({id})'].patch
$.paths['/api/v1/admin/ProductKitSections/Default.Default()'].get
$.paths['/api/v1/admin/productkitsections/delete'].delete
$.paths['/api/v1/admin/productkitsections({key})/customproperties({custompropertyKey})'].get
$.paths['/api/v1/admin/productkitsections({key})/productkitsectionoptions({productkitsectionoptionKey})'].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 Sections API
  version: 1.0.0
extends: openapi/optimizely-product-kit-sections-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: 10
- target: $.paths['/api/v1/admin/ProductKitSections'].get
  update:
    x-apievangelist-phrasing:
      intent: List product kit sections
      effect: read
      questions:
      - How do I list the sections that make up configurable product kits?
      - Can I filter kit sections to those belonging to one product?
      instructions:
      - text: List all product kit sections.
      - text: List kit sections matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a section to a product kit
      effect: write
      questions:
      - How do I add a new section to a configurable product kit?
      - Can I set the label and display order when creating a kit section?
      instructions:
      - text: Create a kit section {sectionName} on product {productId}.
        slots:
          sectionName: requestBody.sectionName
          productId: requestBody.productId
      - text: Add a kit section labelled {label} at sort order {sortOrder} to product {productId}.
        slots:
          label: requestBody.label
          sortOrder: requestBody.sortOrder
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product kit section
      effect: read
      questions:
      - How do I look up a single kit section by its ID?
      - Can I expand the options of one product kit section?
      instructions:
      - text: Get product kit section {id}.
        slots:
          id: path.id
      - text: Show kit section {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product kit section
      effect: write
      questions:
      - How do I overwrite a whole kit section record?
      - Is there a way to fully replace a kit section instead of patching it?
      instructions:
      - text: Replace kit section {id} with name {sectionName} and label {label}.
        slots:
          id: path.id
          sectionName: requestBody.sectionName
          label: requestBody.label
      - text: Overwrite product kit section {id} entirely for product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product kit section
      effect: destructive
      questions:
      - How do I remove one section from a product kit?
      - Can I delete a kit section only if it hasn't changed since I read it?
      instructions:
      - text: Delete product kit section {id}.
        slots:
          id: path.id
      - text: Remove kit section {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product kit section
      effect: write
      questions:
      - How do I rename the label shown on a kit section?
      - Can I move a kit section up or down by changing its sort order?
      instructions:
      - text: Change the label of kit section {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      - text: Set sort order {sortOrder} on kit section {id}.
        slots:
          sortOrder: requestBody.sortOrder
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductKitSections/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank kit section template
      effect: read
      questions:
      - What default values does a new product kit section start with?
      - Can I fetch an empty kit section template before creating one?
      instructions:
      - text: Fetch the default product kit section template.
      - text: Show me the starting values for a new kit section.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productkitsections/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete product kit sections
      effect: destructive
      questions:
      - How do I delete several kit sections at once?
      - Can I remove a batch of product kit sections by ID?
      instructions:
      - text: Bulk delete the product kit sections with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these kit sections in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productkitsections({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a kit section
      effect: read
      questions:
      - How do I read a custom property stored on a product kit section?
      - Can I fetch one extra field value from a kit section?
      instructions:
      - text: Get custom property {custompropertyKey} on kit section {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of product kit section {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productkitsections({key})/productkitsectionoptions({productkitsectionoptionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an option within a kit section
      effect: read
      questions:
      - How do I see one of the selectable options inside a kit section?
      - Can I read a single product kit section option by its key?
      instructions:
      - text: Get option {productkitsectionoptionKey} in kit section {key}.
        slots:
          productkitsectionoptionKey: path.productkitsectionoptionKey
          key: path.key
      - text: Show the choice {productkitsectionoptionKey} offered by kit section {key}.
        slots:
          productkitsectionoptionKey: path.productkitsectionoptionKey
          key: path.key
      method: generated
      generated: '2026-09-26'