Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-category-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/CategoryAttributeValues'].get
$.paths['/api/v1/admin/CategoryAttributeValues'].post
$.paths['/api/v1/admin/CategoryAttributeValues({id})'].get
$.paths['/api/v1/admin/CategoryAttributeValues({id})'].put
$.paths['/api/v1/admin/CategoryAttributeValues({id})'].delete
$.paths['/api/v1/admin/CategoryAttributeValues({id})'].patch
$.paths['/api/v1/admin/CategoryAttributeValues/Default.Default()'].get
$.paths['/api/v1/admin/categoryattributevalues/delete'].delete
$.paths['/api/v1/admin/categoryattributevalues({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 Category Attribute Values API
  version: 1.0.0
extends: openapi/optimizely-category-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/CategoryAttributeValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List category attribute value links
      effect: read
      questions:
      - Which attribute values are assigned to which categories?
      - Can I filter category attribute values by category?
      instructions:
      - text: List all category attribute values.
      - text: List category attribute values matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryAttributeValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an attribute value to a category
      effect: write
      questions:
      - How do I attach an attribute value to a product category?
      - Can I link an existing attribute value to a category for faceting?
      instructions:
      - text: Assign attribute value {attributeValueId} to category {categoryId}.
        slots:
          attributeValueId: requestBody.attributeValueId
          categoryId: requestBody.categoryId
      - text: Link category {categoryId} with attribute value {attributeValueId}.
        slots:
          categoryId: requestBody.categoryId
          attributeValueId: requestBody.attributeValueId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryAttributeValues({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category attribute value link
      effect: read
      questions:
      - How do I look up one category-to-attribute-value link?
      - Which category and value does a specific link record connect?
      instructions:
      - text: Get category attribute value {id}.
        slots:
          id: path.id
      - text: Show which category and value link {id} connects.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryAttributeValues({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a category attribute value link
      effect: write
      questions:
      - How do I overwrite a category attribute value record completely?
      - Can I repoint a whole link record to a different category and value?
      instructions:
      - text: Replace category attribute value {id} with category {categoryId} and value {attributeValueId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
          attributeValueId: requestBody.attributeValueId
      - text: Fully overwrite category attribute value link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryAttributeValues({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attribute value from a category
      effect: destructive
      questions:
      - How do I unassign an attribute value from a category?
      - Can I delete a category attribute value link only if its ETag matches?
      instructions:
      - text: Delete category attribute value {id}.
        slots:
          id: path.id
      - text: Delete category attribute value link {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/CategoryAttributeValues({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a category attribute value link
      effect: write
      questions:
      - How do I switch just the attribute value on a category link?
      - Can I move a category attribute value link to another category?
      instructions:
      - text: Change the attribute value on link {id} to {attributeValueId}.
        slots:
          id: path.id
          attributeValueId: requestBody.attributeValueId
      - text: Move category attribute value link {id} to category {categoryId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryAttributeValues/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default category attribute value template
      effect: read
      questions:
      - What default values does a new category attribute value link start with?
      - Where can I get a blank category attribute value record?
      instructions:
      - text: Get the default category attribute value template.
      - text: Show default values for a new category attribute value link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categoryattributevalues/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete category attribute value links
      effect: destructive
      questions:
      - How do I remove many category attribute value links at once?
      - Can I bulk delete category attribute values by id?
      instructions:
      - text: Delete category attribute values {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove category attribute value links {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categoryattributevalues({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category attribute value custom property
      effect: read
      questions:
      - How do I read a custom property on a category attribute value link?
      - Where is one custom property value for a category attribute value?
      instructions:
      - text: Get custom property {custompropertyKey} of category attribute value {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show category attribute value {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'