API Evangelist conversational phrasing for Admin API V1 Attribute Types 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 Attribute Types API
  version: 1.0.0
extends: openapi/optimizely-attribute-types-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: 13
- target: $.paths['/api/v1/admin/AttributeTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List product attribute types
      effect: read
      questions:
      - What product attribute types are defined in the catalog, like color or size?
      - Can I list only the attribute types that are used as search filters?
      instructions:
      - text: List all attribute types.
      - text: List attribute types where {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an attribute type
      effect: write
      questions:
      - How do I add a new product attribute such as material to the catalog?
      - Can a new attribute type be made filterable and comparable when I create it?
      instructions:
      - text: Create attribute type {name} labeled {label}.
        slots:
          name: requestBody.name
          label: requestBody.label
      - text: Add a new attribute type {name} with filter enabled set to {isFilter}.
        slots:
          name: requestBody.name
          isFilter: requestBody.isFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attribute type by id
      effect: read
      questions:
      - Can I look up one attribute type's settings by its id?
      - Is a particular attribute type searchable and shown on the product page?
      instructions:
      - text: Get attribute type {id}.
        slots:
          id: path.id
      - text: Fetch attribute type {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an attribute type
      effect: write
      questions:
      - Is there a way to overwrite every field of an attribute type at once?
      - What does a full replacement of an attribute type require?
      instructions:
      - text: Replace attribute type {id} with name {name} and label {label}.
        slots:
          id: path.id
          name: requestBody.name
          label: requestBody.label
      - text: Overwrite the full attribute type record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an attribute type
      effect: destructive
      questions:
      - Can I permanently delete one attribute type by id?
      - Does removing a single attribute type accept an If-Match ETag?
      instructions:
      - text: Delete attribute type {id}.
        slots:
          id: path.id
      - text: Delete attribute type {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an attribute type
      effect: write
      questions:
      - How do I turn off an attribute type without resending all its fields?
      - Can I just rename the label of an existing attribute type?
      instructions:
      - text: Set attribute type {id} active flag to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      - text: Change the label on attribute type {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank attribute type template
      effect: read
      questions:
      - What default settings does a new attribute type start with?
      - Is there an empty attribute type template to fill in?
      instructions:
      - text: Get the default attribute type template.
      - text: Show the default values for a new attribute type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AttributeTypes/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive attribute types via the archive action
      effect: write
      questions:
      - Can I archive attribute types by posting to the archive action instead of deleting them?
      - Which POST action retires several attribute types while keeping their history?
      instructions:
      - text: Archive attribute types {ids} using the POST archive action.
        slots:
          ids: query.ids
      - text: Call the archive action on attribute types {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/attributetypes/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive attribute types via the DELETE route
      effect: destructive
      questions:
      - Is there a DELETE archive route for attribute types?
      - Can I archive attribute types with an HTTP DELETE on the archive path?
      instructions:
      - text: Archive attribute types {ids} through the DELETE archive route.
        slots:
          ids: query.ids
      - text: Send a DELETE to the attribute type archive path for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/attributetypes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete attribute types
      effect: destructive
      questions:
      - Can I permanently delete many attribute types in a single request?
      - Is there a bulk delete route that takes a list of attribute type ids?
      instructions:
      - text: Bulk delete attribute types {ids}.
        slots:
          ids: query.ids
      - text: 'Permanently remove these attribute types: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/attributetypes({key})/attributevalues({attributevalueKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a value of an attribute type
      effect: read
      questions:
      - Can I read one allowed value, like Red, under an attribute type?
      - What does a single attribute value record for an attribute type contain?
      instructions:
      - text: Get attribute value {attributevalueKey} of attribute type {key}.
        slots:
          attributevalueKey: path.attributevalueKey
          key: path.key
      - text: Show value {attributevalueKey} defined under attribute type {key}.
        slots:
          attributevalueKey: path.attributevalueKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/attributetypes({key})/categoryattributetypes({categoryattributetypeKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category link for an attribute type
      effect: read
      questions:
      - Which categories use a given attribute type?
      - Can I read one category assignment of an attribute type?
      instructions:
      - text: Get category attribute type {categoryattributetypeKey} for attribute type {key}.
        slots:
          categoryattributetypeKey: path.categoryattributetypeKey
          key: path.key
      - text: Show the category link {categoryattributetypeKey} on attribute type {key}.
        slots:
          categoryattributetypeKey: path.categoryattributetypeKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/attributetypes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an attribute type
      effect: read
      questions:
      - How can I read a custom property stored on an attribute type?
      - Can extra metadata on an attribute type be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on attribute type {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read attribute type {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'