API Evangelist conversational phrasing for Admin API V1 Translation Properties 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 Translation Properties API
  version: 1.0.0
extends: openapi/optimizely-translation-properties-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/TranslationProperties'].get
  update:
    x-apievangelist-phrasing:
      intent: List translated property values
      effect: read
      questions:
      - Which translated field values exist across my commerce data?
      - Can I filter translation properties by language or parent table?
      instructions:
      - text: List all translation properties.
      - text: List translation properties matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a translation for a property
      effect: write
      questions:
      - How do I store a translated value for a field on a product or other record?
      - What do I need to supply to add a translation property - table, name and value?
      instructions:
      - text: 'Add a {languageId} translation of {name} on {parentTable} record {parentId}: {translatedValue}.'
        slots:
          languageId: requestBody.languageId
          name: requestBody.name
          parentTable: requestBody.parentTable
          parentId: requestBody.parentId
          translatedValue: requestBody.translatedValue
      - text: Create translation property {name} for table {parentTable} with value {translatedValue}.
        slots:
          name: requestBody.name
          parentTable: requestBody.parentTable
          translatedValue: requestBody.translatedValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one translation property
      effect: read
      questions:
      - How do I look up a single translated value by its ID?
      - Can I select just certain fields of one translation property?
      instructions:
      - text: Get translation property {id}.
        slots:
          id: path.id
      - text: Show only {select} of translation property {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a translation property
      effect: write
      questions:
      - How do I overwrite a translation property record completely?
      - Does replacing a translation require resending the table, name and value?
      instructions:
      - text: Replace translation property {id} with {name} on {parentTable} = {translatedValue}.
        slots:
          id: path.id
          name: requestBody.name
          parentTable: requestBody.parentTable
          translatedValue: requestBody.translatedValue
      - text: Fully overwrite translation record {id} for language {languageId}.
        slots:
          id: path.id
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a translation property
      effect: destructive
      questions:
      - How do I remove a translated value I no longer need?
      - Can I delete a translation only if nobody changed it since I read it?
      instructions:
      - text: Delete translation property {id}.
        slots:
          id: path.id
      - text: Delete translation {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a translated value
      effect: write
      questions:
      - Can I just fix the wording of an existing translation?
      - How do I correct only the translated text without resending the rest?
      instructions:
      - text: Change translation {id} to read {translatedValue}.
        slots:
          id: path.id
          translatedValue: requestBody.translatedValue
      - text: Switch translation property {id} to language {languageId}.
        slots:
          id: path.id
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on translations
      effect: read
      questions:
      - What does the Default OData function on translation properties return?
      - Is there a default translation property template to start from?
      instructions:
      - text: Call the Default function on translation properties.
      - text: Get the default translation property entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/TranslationProperties/Default.forentity(entityName=\'{entityName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get translation properties for an entity type
      effect: read
      questions:
      - Which translatable properties exist for a given entity like product or category?
      - Can I call the Default.forentity function to see translations for one entity type?
      instructions:
      - text: Call Default.forentity for entity {entityName}.
        slots:
          entityName: path.entityName
      - text: Get translation properties for the {entityName} entity via the Default namespace function.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/translationproperties/forentity(entityName=\'{entityName}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get translations for an entity (short route)
      effect: read
      questions:
      - Is there a shorter forentity route without the Default prefix for entity translations?
      - Can I use the lowercase translationproperties/forentity path to list an entity's translations?
      instructions:
      - text: Use the short forentity route to list translations for {entityName}.
        slots:
          entityName: path.entityName
      - text: Get {entityName} translations from translationproperties/forentity.
        slots:
          entityName: path.entityName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/translationproperties/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete translation properties
      effect: destructive
      questions:
      - Can I delete many translation properties with one call?
      - How do I remove a batch of translations by their IDs?
      instructions:
      - text: Bulk delete translation properties {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these translations in one go: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/translationproperties({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a translation
      effect: read
      questions:
      - How do I read a custom property attached to a translation property record?
      - Can translation properties themselves carry custom fields?
      instructions:
      - text: Get custom property {custompropertyKey} of translation property {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on translation record {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'