Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Style Trait Value Products API

10 actions 10 updates phrasing extends openapi/optimizely-style-trait-value-products-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/StyleTraitValueProducts'].get
$.paths['/api/v1/admin/StyleTraitValueProducts'].post
$.paths['/api/v1/admin/StyleTraitValueProducts({id})'].get
$.paths['/api/v1/admin/StyleTraitValueProducts({id})'].put
$.paths['/api/v1/admin/StyleTraitValueProducts({id})'].delete
$.paths['/api/v1/admin/StyleTraitValueProducts({id})'].patch
$.paths['/api/v1/admin/StyleTraitValueProducts/Default.Default()'].get
$.paths['/api/v1/admin/styletraitvalueproducts/delete'].delete
$.paths['/api/v1/admin/styletraitvalueproducts({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 Style Trait Value Products API
  version: 1.0.0
extends: openapi/optimizely-style-trait-value-products-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/StyleTraitValueProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List product style trait value links
      effect: read
      questions:
      - Which products are linked to style trait values like a color or size?
      - Can I filter style trait links down to one product's variants?
      - How many products carry a given style trait value?
      instructions:
      - text: List all product style trait value links.
      - text: Find style trait value product links matching {filter}.
        slots:
          filter: query.$filter
      - text: Count style trait value links matching {filter} with count set to {count}.
        slots:
          filter: query.$filter
          count: query.$count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValueProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a product to a style trait value
      effect: write
      questions:
      - How do I tag a product variant with a style trait value such as Red or Large?
      - What do I need to link a product to a style trait value?
      instructions:
      - text: Link product {productId} to style trait value {styleTraitValueId}.
        slots:
          productId: requestBody.productId
          styleTraitValueId: requestBody.styleTraitValueId
      - text: Give style variant {productId} the trait value {styleTraitValueId}.
        slots:
          productId: requestBody.productId
          styleTraitValueId: requestBody.styleTraitValueId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValueProducts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product style trait value link
      effect: read
      questions:
      - Which product and trait value does a given style link record connect?
      - Can I look up one style trait value product link by ID?
      instructions:
      - text: Get style trait value product link {id}.
        slots:
          id: path.id
      - text: Show the product and trait value on style link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValueProducts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product style trait value link
      effect: write
      questions:
      - How do I overwrite a style trait value link record in full?
      - Does replacing a style link clear fields I leave out?
      instructions:
      - text: Replace style link {id} so product {productId} has trait value {styleTraitValueId}.
        slots:
          id: path.id
          productId: requestBody.productId
          styleTraitValueId: requestBody.styleTraitValueId
      - text: Overwrite style trait value product record {id} for product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValueProducts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a product from a style trait value
      effect: destructive
      questions:
      - How do I remove a style trait value from a product variant?
      - Can I guard removing a style link with an ETag?
      instructions:
      - text: Delete style trait value product link {id}.
        slots:
          id: path.id
      - text: Remove style link {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/StyleTraitValueProducts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product style trait value link
      effect: write
      questions:
      - Can I switch a variant to a different trait value without recreating the link?
      - How do I point an existing style link at another product?
      instructions:
      - text: Change style link {id} to trait value {styleTraitValueId}.
        slots:
          id: path.id
          styleTraitValueId: requestBody.styleTraitValueId
      - text: Point style trait value link {id} at product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValueProducts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank style trait link template
      effect: read
      questions:
      - What default values does a new style trait value product link start with?
      - Is there an empty template for a style trait link?
      instructions:
      - text: Fetch the default style trait value product template.
      - text: Show default values for a new product style trait link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styletraitvalueproducts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk unlink products from style trait values
      effect: destructive
      questions:
      - How do I delete many style trait value links at once?
      - Can I remove a batch of product style links by ID?
      instructions:
      - text: Bulk delete style trait value product links {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these product style links in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styletraitvalueproducts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a style trait link
      effect: read
      questions:
      - What value is stored in a custom property on a style trait value link?
      - Can I read one custom property of a product style link?
      instructions:
      - text: Get custom property {custompropertyKey} on style link {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show style trait value product {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'