Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Style Trait Values API

11 actions 11 updates phrasing extends openapi/optimizely-style-trait-values-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/StyleTraitValues'].get
$.paths['/api/v1/admin/StyleTraitValues'].post
$.paths['/api/v1/admin/StyleTraitValues({id})'].get
$.paths['/api/v1/admin/StyleTraitValues({id})'].put
$.paths['/api/v1/admin/StyleTraitValues({id})'].delete
$.paths['/api/v1/admin/StyleTraitValues({id})'].patch
$.paths['/api/v1/admin/StyleTraitValues/Default.Default()'].get
$.paths['/api/v1/admin/styletraitvalues/delete'].delete
$.paths['/api/v1/admin/styletraitvalues({key})/customproperties({custompropertyKey})'].get
$.paths['/api/v1/admin/styletraitvalues({key})/products({productKey})'].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 Values API
  version: 1.0.0
extends: openapi/optimizely-style-trait-values-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/StyleTraitValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List style trait values
      effect: read
      questions:
      - How can I see all the style trait values, like each color or size option?
      - Can I filter style trait values to only the defaults for a trait?
      instructions:
      - text: List all style trait values.
      - text: List style trait values matching {filter}, sorted by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a style trait value
      effect: write
      questions:
      - How do I add a new option such as a color to a style trait?
      - Can I give a new style trait value a color swatch?
      instructions:
      - text: Add style trait value {value} described as {description} to trait {styleTraitId}.
        slots:
          value: requestBody.value
          description: requestBody.description
          styleTraitId: requestBody.styleTraitId
      - text: Create style trait value {value} ({description}) with swatch color {swatchColorValue}.
        slots:
          value: requestBody.value
          description: requestBody.description
          swatchColorValue: requestBody.swatchColorValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one style trait value
      effect: read
      questions:
      - How can I look up a single style trait value by id?
      - Can I pull just the swatch fields for one style trait value?
      instructions:
      - text: Show style trait value {id}.
        slots:
          id: path.id
      - text: Fetch {select} from style trait value {id}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a style trait value
      effect: write
      questions:
      - How do I overwrite all fields of a style trait value?
      - Will a full replace of a style trait value clear its swatch if I leave it out?
      instructions:
      - text: Replace style trait value {id} with value {value} and description {description}.
        slots:
          id: path.id
          value: requestBody.value
          description: requestBody.description
      - text: Overwrite the full record of style trait value {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one style trait value
      effect: destructive
      questions:
      - How do I remove a single style trait value?
      - Can I delete a style trait value conditionally with an ETag?
      instructions:
      - text: Delete style trait value {id}.
        slots:
          id: path.id
      - text: Remove style trait value {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields of a style trait value
      effect: write
      questions:
      - How can I change the sort order of one style trait value?
      - Can I make an existing style trait value the default option?
      instructions:
      - text: Set sort order of style trait value {id} to {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      - text: 'Mark style trait value {id} as default: {isDefault}.'
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleTraitValues/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new style trait value
      effect: read
      questions:
      - What default values does a new style trait value start with?
      - Where do I get an empty style trait value template?
      instructions:
      - text: Fetch the default style trait value template.
      - text: Show starting values for a new style trait value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styletraitvalues/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete style trait values
      effect: destructive
      questions:
      - How do I delete several style trait values at once?
      - Can I pass a list of ids to remove style trait options?
      instructions:
      - text: Bulk delete style trait values {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every style trait value in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styletraitvalues({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a style trait value
      effect: read
      questions:
      - Where can I read a custom property on a style trait value?
      - How do I fetch one custom attribute from a style trait value?
      instructions:
      - text: Get custom property {custompropertyKey} of style trait value {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom field {custompropertyKey} on style trait value {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styletraitvalues({key})/products({productKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product using a style trait value
      effect: read
      questions:
      - Which products are tied to a given style trait value?
      - How do I check one product linked to a style trait value?
      instructions:
      - text: Get product {productKey} linked to style trait value {key}.
        slots:
          key: path.key
          productKey: path.productKey
      - text: Confirm product {productKey} uses style trait value {key}.
        slots:
          key: path.key
          productKey: path.productKey
      method: generated
      generated: '2026-09-26'