# 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 Entity Configurations API
  version: 1.0.0
extends: openapi/optimizely-entity-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/EntityConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin entity configurations
      effect: read
      questions:
      - How do I list the entity configurations that shape the admin console?
      - Can I filter entity configurations to those users can delete?
      - Which entity configurations exist and how many are there?
      instructions:
      - text: List all entity configurations.
      - text: List entity configurations matching {filter}.
        slots:
          filter: query.$filter
      - text: Count entity configurations and return the first {top}.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an entity configuration
      effect: write
      questions:
      - How do I define a new entity configuration with a label and permissions?
      - Can I set whether admins can create or delete an entity when configuring it?
      instructions:
      - text: Create an entity configuration named {name} labeled {label}.
        slots:
          name: requestBody.name
          label: requestBody.label
      - text: Add entity configuration {name} with plural label {pluralizedLabel} and delete allowed {canDelete}.
        slots:
          name: requestBody.name
          pluralizedLabel: requestBody.pluralizedLabel
          canDelete: requestBody.canDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityConfigurations({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity configuration
      effect: read
      questions:
      - Is there a call to read a single entity configuration by ID?
      - What label and permissions does a specific entity configuration have?
      instructions:
      - text: Get entity configuration {id}.
        slots:
          id: path.id
      - text: Show the label and permissions of entity configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityConfigurations({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an entity configuration
      effect: write
      questions:
      - What's the call to overwrite an entire entity configuration?
      - What happens to fields I omit when replacing an entity configuration?
      instructions:
      - text: Replace entity configuration {id} with name {name} and label {label}.
        slots:
          id: path.id
          name: requestBody.name
          label: requestBody.label
      - text: Overwrite the full entity configuration {id} using description {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityConfigurations({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entity configuration
      effect: destructive
      questions:
      - How do I remove an entity configuration by ID?
      - Can I delete an entity configuration only if nobody has changed it?
      instructions:
      - text: Delete entity configuration {id}.
        slots:
          id: path.id
      - text: Delete entity configuration {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/EntityConfigurations({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an entity configuration
      effect: write
      questions:
      - How do I change the instructional text shown for an entity?
      - Can I turn off editing on an entity configuration without replacing it?
      instructions:
      - text: Set the instructional text of entity configuration {id} to {instructionalText}.
        slots:
          id: path.id
          instructionalText: requestBody.instructionalText
      - text: Set can-edit to {canEdit} on entity configuration {id}.
        slots:
          id: path.id
          canEdit: requestBody.canEdit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityConfigurations/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default entity configuration
      effect: read
      questions:
      - What does a default entity configuration look like?
      - Where do I get starting values for a new entity configuration?
      instructions:
      - text: Get the default entity configuration template.
      - text: Show default values for a new entity configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entityconfigurations/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete entity configurations
      effect: destructive
      questions:
      - Can I delete several entity configurations in one call?
      - Can I remove a list of entity configurations by their IDs?
      instructions:
      - text: Bulk delete entity configurations {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these entity configurations all at once: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entityconfigurations({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an entity configuration
      effect: read
      questions:
      - Where would I read a custom property on an entity configuration?
      - Can I look up an extra attribute stored against an entity configuration?
      instructions:
      - text: Get custom property {prop} on entity configuration {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      - text: Show custom field {prop} for entity configuration {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entityconfigurations({key})/entitypermissions({entitypermissionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission on an entity configuration
      effect: read
      questions:
      - Which role permission applies to an entity configuration?
      - Can I read one entity permission rule by its key?
      instructions:
      - text: Get permission {perm} on entity configuration {key}.
        slots:
          key: path.key
          perm: path.entitypermissionKey
      - text: Show entity permission rule {perm} for configuration {key}.
        slots:
          key: path.key
          perm: path.entitypermissionKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entityconfigurations({key})/propertyconfigurations({propertyconfigurationKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a property configuration of an entity
      effect: read
      questions:
      - Can I see how a single field is configured on an entity?
      - Can I read one property configuration under an entity configuration?
      instructions:
      - text: Get property configuration {prop} on entity configuration {key}.
        slots:
          key: path.key
          prop: path.propertyconfigurationKey
      - text: Show how field configuration {prop} is set up in entity {key}.
        slots:
          key: path.key
          prop: path.propertyconfigurationKey
      method: generated
      generated: '2026-09-26'