API Evangelist conversational phrasing for Admin API V1 Style Classes API

# 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 Classes API
  version: 1.0.0
extends: openapi/optimizely-style-classes-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: 12
- target: $.paths['/api/v1/admin/StyleClasses'].get
  update:
    x-apievangelist-phrasing:
      intent: List product style classes
      effect: read
      questions:
      - Which style classes are defined in my commerce catalog?
      - Can I list only the active style classes, sorted by name?
      instructions:
      - text: List all style classes.
      - text: Find style classes matching the filter {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a style class
      effect: write
      questions:
      - How do I create a new style class for product variants?
      - What is required when adding a style class, name and description?
      instructions:
      - text: Create a style class named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add a new active style class {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a style class by ID
      effect: read
      questions:
      - What are the details of one style class by its ID?
      - Is a specific style class still active?
      instructions:
      - text: Get style class {id}.
        slots:
          id: path.id
      - text: Show the name, description and active flag of style class {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a style class
      effect: write
      questions:
      - Can I overwrite a whole style class record in one request?
      - Does a full replace of a style class need name and description again?
      instructions:
      - text: Replace style class {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite the entire style class {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a style class by ID
      effect: destructive
      questions:
      - How do I permanently delete one style class?
      - Does deleting a style class accept an If-Match ETag?
      instructions:
      - text: Delete style class {id}.
        slots:
          id: path.id
      - text: Delete style class {id} only if its ETag matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a style class
      effect: write
      questions:
      - How do I rename an existing style class?
      - Can I deactivate a style class without replacing the whole record?
      instructions:
      - text: Rename style class {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set isActive to {isActive} on style class {id}.
        slots:
          isActive: requestBody.isActive
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default style class template
      effect: read
      questions:
      - What default values does a new style class start with?
      - Is there a blank style class template to fetch before creating one?
      instructions:
      - text: Fetch the default style class template.
      - text: Show me the default values for a new style class.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/StyleClasses/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive style classes with the archive action
      effect: write
      questions:
      - Can I archive style classes using the OData archive action instead of deleting them?
      - Which POST call archives a list of style classes by ID?
      instructions:
      - text: Run the Default.archive action on style classes {ids}.
        slots:
          ids: query.ids
      - text: POST to the archive action to archive style classes {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styleclasses/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive style classes through the DELETE archive route
      effect: destructive
      questions:
      - Is there a DELETE route that archives style classes rather than removing them?
      - How does the /styleclasses/archive endpoint handle a list of IDs?
      instructions:
      - text: Archive style classes {ids} through the DELETE /styleclasses/archive route.
        slots:
          ids: query.ids
      - text: Send a DELETE to the style class archive route for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styleclasses/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete style classes
      effect: destructive
      questions:
      - How do I permanently delete several style classes at once?
      - Can I pass a list of IDs to remove many style classes?
      instructions:
      - text: Bulk delete the style classes with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Permanently remove all of these style classes in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styleclasses({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a style class
      effect: read
      questions:
      - Where do I read a custom property stored on a style class?
      - Can I fetch one extra property value from a style class record?
      instructions:
      - text: Get custom property {custompropertyKey} on style class {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of style class {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/styleclasses({key})/styletraits({styletraitKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a style trait within a style class
      effect: read
      questions:
      - What does one style trait, such as color or size, look like inside a style class?
      - Can I fetch a single style trait belonging to a style class?
      instructions:
      - text: Get style trait {styletraitKey} of style class {key}.
        slots:
          styletraitKey: path.styletraitKey
          key: path.key
      - text: Show the details of trait {styletraitKey} in style class {key}.
        slots:
          styletraitKey: path.styletraitKey
          key: path.key
      method: generated
      generated: '2026-09-26'