# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BlueConic REST API v2 Properties API
  version: 1.0.0
extends: openapi/blueconic-properties-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/profileProperties/{propertyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a profile or group property
      effect: read
      questions:
      - How is one profile property defined?
      - Can I check a property's settings like its data sensitivity?
      instructions:
      - text: Get property {propertyId}.
        slots:
          propertyId: path.propertyId
      - text: Show the definition of property {propertyId}.
        slots:
          propertyId: path.propertyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profileProperties/{propertyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a profile or group property
      effect: write
      questions:
      - How do I add a new custom profile property?
      - Can I make an existing property available for segmentation or indexed?
      - Is it possible to set a property's merge strategy?
      instructions:
      - text: Create or update property {propertyId} named {name}.
        slots:
          propertyId: path.propertyId
          name: requestBody.name
      - text: Set the merge strategy of property {propertyId} to {mergeStrategy}.
        slots:
          propertyId: path.propertyId
          mergeStrategy: requestBody.mergeStrategy
      - text: 'Mark property {propertyId} as indexed: {indexed}.'
        slots:
          propertyId: path.propertyId
          indexed: requestBody.indexed
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profileProperties/{propertyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a profile or group property
      effect: destructive
      questions:
      - How do I remove a property we no longer use?
      - Can I delete a group property the same way as a profile property?
      instructions:
      - text: Delete property {propertyId}.
        slots:
          propertyId: path.propertyId
      - text: Remove the property {propertyId} from the account.
        slots:
          propertyId: path.propertyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profileProperties'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile or group properties
      effect: read
      questions:
      - Which profile properties exist in our account?
      - Can I list the properties of a group type instead of profiles?
      - Is there a way to filter properties by name?
      instructions:
      - text: List all profile properties.
      - text: List the properties of group type {groupTypeId}.
        slots:
          groupTypeId: query.groupTypeId
      - text: Find properties whose {filterType} matches {filterValue}.
        slots:
          filterType: query.filterType
          filterValue: query.filterValue
      method: generated
      generated: '2026-10-01'