API Evangelist conversational phrasing for Admin API V1 Property Configurations 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 Property Configurations API
  version: 1.0.0
extends: openapi/optimizely-property-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: 11
- target: $.paths['/api/v1/admin/PropertyConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List property configurations
      effect: read
      questions:
      - Which field configurations are defined for admin entities?
      - Can I list only the custom properties flagged as PII?
      instructions:
      - text: List all property configurations.
      - text: Find property configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a property configuration
      effect: write
      questions:
      - How do I add a new custom field configuration to an entity?
      - Can I mark a new property as required, translatable or PII when I create it?
      instructions:
      - text: Create property configuration {name} labelled {label} on entity configuration {entityConfigurationId}.
        slots:
          name: requestBody.name
          label: requestBody.label
          entityConfigurationId: requestBody.entityConfigurationId
      - text: Add a new custom property {name} with control type {controlType}.
        slots:
          name: requestBody.name
          controlType: requestBody.controlType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyConfigurations({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a property configuration by ID
      effect: read
      questions:
      - What control type and label does one property configuration use?
      - Is a specific property configuration set to sync to PIM?
      instructions:
      - text: Get property configuration {id}.
        slots:
          id: path.id
      - text: Show the settings of property configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyConfigurations({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a property configuration
      effect: write
      questions:
      - Can I overwrite an entire property configuration record at once?
      - What happens to omitted fields when I fully replace a property configuration?
      instructions:
      - text: Replace property configuration {id} with this full definition.
        slots:
          id: path.id
      - text: Overwrite property configuration {id} using a full PUT with label {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyConfigurations({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property configuration by ID
      effect: destructive
      questions:
      - How do I delete one property configuration?
      - Does removing a property configuration honor an If-Match ETag?
      instructions:
      - text: Delete property configuration {id}.
        slots:
          id: path.id
      - text: Delete property configuration {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/PropertyConfigurations({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a property configuration
      effect: write
      questions:
      - How do I change the hint text or tooltip of an existing property?
      - Can I make an existing property required without resending the whole record?
      instructions:
      - text: Set the tooltip of property configuration {id} to {toolTip}.
        slots:
          id: path.id
          toolTip: requestBody.toolTip
      - text: Mark property configuration {id} as required = {isRequired}.
        slots:
          id: path.id
          isRequired: requestBody.isRequired
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PropertyConfigurations/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default property configuration template
      effect: read
      questions:
      - What default values does a new property configuration start with?
      - Is there a blank property configuration template to fetch first?
      instructions:
      - text: Fetch the default property configuration template.
      - text: Show me the default values for a new property configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyconfigurations/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete property configurations
      effect: destructive
      questions:
      - How do I delete several property configurations at once?
      - Can I pass a list of IDs to remove many property configurations?
      instructions:
      - text: Bulk delete the property configurations with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these property configurations in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyconfigurations({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a property configuration
      effect: read
      questions:
      - Where do I read a custom property value attached to a property configuration?
      - Can I fetch one extra property from a property configuration record?
      instructions:
      - text: Get custom property {custompropertyKey} on property configuration {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of property configuration {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyconfigurations({key})/propertyattributeconfigurations({propertyattributeconfigurationKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attribute configuration of a property
      effect: read
      questions:
      - What attribute settings are attached to a property configuration?
      - Can I look up one property attribute configuration under a property?
      instructions:
      - text: Get attribute configuration {propertyattributeconfigurationKey} of property configuration {key}.
        slots:
          propertyattributeconfigurationKey: path.propertyattributeconfigurationKey
          key: path.key
      - text: Show property attribute configuration {propertyattributeconfigurationKey} under property {key}.
        slots:
          propertyattributeconfigurationKey: path.propertyattributeconfigurationKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/propertyconfigurations({key})/propertypermissions({propertypermissionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission rule on a property
      effect: read
      questions:
      - Who can view or edit a given property configuration?
      - Can I fetch a single property permission entry by its key?
      instructions:
      - text: Get property permission {propertypermissionKey} on property configuration {key}.
        slots:
          propertypermissionKey: path.propertypermissionKey
          key: path.key
      - text: Show the view and edit permission {propertypermissionKey} for property {key}.
        slots:
          propertypermissionKey: path.propertypermissionKey
          key: path.key
      method: generated
      generated: '2026-09-26'