Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Product Attribute Values API

10 actions 10 updates phrasing extends openapi/optimizely-product-attribute-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 10

$.info
$.paths['/api/v1/admin/ProductAttributeValues'].get
$.paths['/api/v1/admin/ProductAttributeValues'].post
$.paths['/api/v1/admin/ProductAttributeValues({id})'].get
$.paths['/api/v1/admin/ProductAttributeValues({id})'].put
$.paths['/api/v1/admin/ProductAttributeValues({id})'].delete
$.paths['/api/v1/admin/ProductAttributeValues({id})'].patch
$.paths['/api/v1/admin/ProductAttributeValues/Default.Default()'].get
$.paths['/api/v1/admin/productattributevalues/delete'].delete
$.paths['/api/v1/admin/productattributevalues({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 Attribute Values API
  version: 1.0.0
extends: openapi/optimizely-product-attribute-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: 9
- target: $.paths['/api/v1/admin/ProductAttributeValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List product attribute value links
      effect: read
      questions:
      - Which attribute values, like color or size, are assigned to my products?
      - Can I filter product attribute assignments to one product?
      instructions:
      - text: List product attribute value assignments.
      - text: List product attribute values matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductAttributeValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an attribute value to a product
      effect: write
      questions:
      - How do I tag a product with an attribute value such as Blue?
      - Can I link an existing attribute value to a product?
      instructions:
      - text: Assign attribute value {attributeValueId} to product {productId}.
        slots:
          attributeValueId: requestBody.attributeValueId
          productId: requestBody.productId
      - text: Link product {productId} to attribute value {attributeValueId}.
        slots:
          productId: requestBody.productId
          attributeValueId: requestBody.attributeValueId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductAttributeValues({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product attribute value link
      effect: read
      questions:
      - Can I look up one product-to-attribute assignment by its id?
      - Which product and attribute value does a given assignment connect?
      instructions:
      - text: Get product attribute value {id}.
        slots:
          id: path.id
      - text: Show the product and value behind assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductAttributeValues({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product attribute value link
      effect: write
      questions:
      - Is there a way to overwrite a product attribute assignment completely?
      - What does a full replace of a product attribute value record need?
      instructions:
      - text: Replace assignment {id} so product {productId} uses value {attributeValueId}.
        slots:
          id: path.id
          productId: requestBody.productId
          attributeValueId: requestBody.attributeValueId
      - text: Overwrite product attribute value record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductAttributeValues({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attribute value from a product
      effect: destructive
      questions:
      - Can I unassign one attribute value from a product by id?
      - Does removing a single product attribute assignment support If-Match?
      instructions:
      - text: Delete product attribute value {id}.
        slots:
          id: path.id
      - text: Delete assignment {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/ProductAttributeValues({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the value on a product attribute link
      effect: write
      questions:
      - How do I switch a product's attribute to a different value?
      - Can I patch only the attribute value on an existing assignment?
      instructions:
      - text: Point assignment {id} to attribute value {attributeValueId}.
        slots:
          id: path.id
          attributeValueId: requestBody.attributeValueId
      - text: Move attribute assignment {id} to product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ProductAttributeValues/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank product attribute value template
      effect: read
      questions:
      - What default values does a new product attribute assignment start with?
      - Is there an empty template for a product attribute value?
      instructions:
      - text: Get the default product attribute value template.
      - text: Show starting values for a new product attribute assignment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productattributevalues/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove product attribute values
      effect: destructive
      questions:
      - Can I remove many product attribute assignments at once?
      - Is there a bulk delete that takes a list of assignment ids?
      instructions:
      - text: Bulk delete product attribute values {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these attribute assignments in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/productattributevalues({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a product attribute value
      effect: read
      questions:
      - How can I read a custom property on a product attribute assignment?
      - Can extra metadata on a product attribute value be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on product attribute value {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read assignment {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'