Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Property Attribute Configurations API

10 actions 10 updates phrasing extends openapi/optimizely-property-attribute-configurations-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/PropertyAttributeConfigurations'].get
$.paths['/api/v1/admin/PropertyAttributeConfigurations'].post
$.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].get
$.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].put
$.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].delete
$.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].patch
$.paths['/api/v1/admin/PropertyAttributeConfigurations/Default.Default()'].get
$.paths['/api/v1/admin/propertyattributeconfigurations/delete'].delete
$.paths['/api/v1/admin/propertyattributeconfigurations({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 Property Attribute Configurations API
  version: 1.0.0
extends: openapi/optimizely-property-attribute-configurations-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/PropertyAttributeConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List property attribute configurations
      effect: read
      questions:
      - Which name/value attributes are configured on admin property configurations?
      - Can I filter property attribute configurations by name?
      instructions:
      - text: List all property attribute configurations.
      - text: List property attribute configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyAttributeConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an attribute to a property configuration
      effect: write
      questions:
      - How do I add a name and value attribute to a property configuration?
      - What fields does a new property attribute configuration require?
      instructions:
      - text: Add attribute {name} = {value} to property configuration {propertyConfigurationId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          propertyConfigurationId: requestBody.propertyConfigurationId
      - text: Create property attribute {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a property attribute configuration
      effect: read
      questions:
      - Can I look up one property attribute configuration by ID?
      - Which property configuration does a given attribute belong to?
      instructions:
      - text: Show property attribute configuration {id}.
        slots:
          id: path.id
      - text: Get property attribute configuration {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a property attribute configuration
      effect: write
      questions:
      - Can I overwrite a property attribute configuration completely?
      - What's the full-replace call for a property attribute?
      instructions:
      - text: Replace property attribute configuration {id} with {name} = {value}.
        slots:
          id: path.id
          name: requestBody.name
          value: requestBody.value
      - text: Overwrite property attribute {id} for configuration {propertyConfigurationId}, named {name} with value {value}.
        slots:
          id: path.id
          propertyConfigurationId: requestBody.propertyConfigurationId
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyAttributeConfigurations({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property attribute configuration
      effect: destructive
      questions:
      - How do I remove one attribute from a property configuration?
      - Can I delete a property attribute only if its ETag matches?
      instructions:
      - text: Delete property attribute configuration {id}.
        slots:
          id: path.id
      - text: Delete property attribute {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/PropertyAttributeConfigurations({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a property attribute's value
      effect: write
      questions:
      - Can I change only the value of a property attribute?
      - Is there a partial update to rename a property attribute?
      instructions:
      - text: Set property attribute configuration {id} value to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Rename property attribute {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyAttributeConfigurations/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a property attribute
      effect: read
      questions:
      - What defaults are pre-filled for a new property attribute configuration?
      - Is there a blank property attribute template?
      instructions:
      - text: Get the default property attribute configuration template.
      - text: Show pre-filled values for a new property attribute.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyattributeconfigurations/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several property attribute configurations
      effect: destructive
      questions:
      - Can I bulk delete property attribute configurations?
      - Which call removes many property attributes by ID?
      instructions:
      - text: Bulk delete property attribute configurations {ids}.
        slots:
          ids: query.ids
      - text: Remove the property attributes {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyattributeconfigurations({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a property attribute
      effect: read
      questions:
      - Can I read a custom field stored on a property attribute configuration?
      - Where are extra attributes of a property attribute configuration kept?
      instructions:
      - text: Get custom property {custompropertyKey} on property attribute configuration {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show property attribute {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'