# 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 Definitions API
  version: 1.0.0
extends: openapi/optimizely-entity-definitions-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: 6
- target: $.paths['/api/v1/admin/EntityDefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin entity definitions
      effect: read
      questions:
      - Which entity types does the commerce admin define, with their properties?
      - Can I see the metadata for every admin entity at once?
      instructions:
      - text: List all entity definitions.
      - text: Show entity definitions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityDefinitions(\'{name}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity definition by name
      effect: read
      questions:
      - What properties does a specific admin entity, like customerOrder, have?
      - Can I fetch the definition of a single entity type by its name?
      instructions:
      - text: Show the entity definition for {name}.
        slots:
          name: path.name
      - text: Get metadata for entity type {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityDefinitions/Default.PropertyValidations(entityName=\'{entityName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get property validations via OData function
      effect: read
      questions:
      - Can I read an entity's field validation rules through the OData PropertyValidations function?
      - Which validation rules apply to an entity's properties, using the Default. function call?
      instructions:
      - text: Get property validations for {entityName} using the Default.PropertyValidations function.
        slots:
          entityName: path.entityName
      - text: Call the OData PropertyValidations function for entity {entityName}.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EntityDefinitions/Default.DisplayNameFormats()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get display name formats via OData function
      effect: read
      questions:
      - How are entity display names formatted, via the OData DisplayNameFormats function?
      - Can I call Default.DisplayNameFormats to see naming templates?
      instructions:
      - text: Call the Default.DisplayNameFormats function.
      - text: Get display name formats through the OData function.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entitydefinitions/PropertyValidations(entityName=\'{entityName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get property validations via route
      effect: read
      questions:
      - Is there a plain route for an entity's property validation rules?
      - What are the required-field and length rules for an entity, from the lowercase entitydefinitions path?
      instructions:
      - text: Get property validations for {entityName} from the PropertyValidations route.
        slots:
          entityName: path.entityName
      - text: Fetch field validation rules of {entityName} via the non-OData path.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/entitydefinitions/displayNameFormats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get display name formats via route
      effect: read
      questions:
      - Is there a simple displayNameFormats route for entity naming templates?
      - Where can I fetch display name formats without OData function syntax?
      instructions:
      - text: Get display name formats from the displayNameFormats route.
      - text: Fetch entity naming templates via the plain displayNameFormats path.
      method: generated
      generated: '2026-09-26'