Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Category Personas API

10 actions 10 updates phrasing extends openapi/optimizely-category-personas-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/CategoryPersonas'].get
$.paths['/api/v1/admin/CategoryPersonas'].post
$.paths['/api/v1/admin/CategoryPersonas({id})'].get
$.paths['/api/v1/admin/CategoryPersonas({id})'].put
$.paths['/api/v1/admin/CategoryPersonas({id})'].delete
$.paths['/api/v1/admin/CategoryPersonas({id})'].patch
$.paths['/api/v1/admin/CategoryPersonas/Default.Default()'].get
$.paths['/api/v1/admin/categorypersonas/delete'].delete
$.paths['/api/v1/admin/categorypersonas({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑
# 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 Category Personas API
  version: 1.0.0
extends: openapi/optimizely-category-personas-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: 9
- target: $.paths['/api/v1/admin/CategoryPersonas'].get
  update:
    x-apievangelist-phrasing:
      intent: List category-persona assignments
      effect: read
      questions:
      - Which catalog categories are targeted to which personas?
      - Can I filter category-persona links for one persona?
      instructions:
      - text: List all category-persona assignments.
      - text: Find category-persona links matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a category to a persona
      effect: write
      questions:
      - How do I show a catalog category only to a certain persona?
      - Can I link a category to a persona?
      instructions:
      - text: Assign category {categoryId} to persona {personaId}.
        slots:
          categoryId: requestBody.categoryId
          personaId: requestBody.personaId
      - text: Link persona {personaId} to category {categoryId}.
        slots:
          categoryId: requestBody.categoryId
          personaId: requestBody.personaId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category-persona assignment
      effect: read
      questions:
      - Can I look up one category-persona link by ID?
      - Which category and persona does a given assignment connect?
      instructions:
      - text: Show category-persona assignment {id}.
        slots:
          id: path.id
      - text: Get the category and persona for link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a category-persona assignment
      effect: write
      questions:
      - How do I overwrite a category-persona link entirely?
      - Can I replace an assignment with a different category and persona pair?
      instructions:
      - text: Replace assignment {id} with category {categoryId} and persona {personaId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
          personaId: requestBody.personaId
      - text: Overwrite category-persona link {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a category-persona assignment
      effect: destructive
      questions:
      - How do I stop targeting a category to a persona?
      - Can I delete one category-persona link with an ETag check?
      instructions:
      - text: Delete category-persona assignment {id}.
        slots:
          id: path.id
      - text: Remove link {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a category-persona assignment
      effect: write
      questions:
      - Can I point an existing assignment at a different persona?
      - How do I change just the category on a category-persona link?
      instructions:
      - text: Move assignment {id} to persona {personaId}.
        slots:
          id: path.id
          personaId: requestBody.personaId
      - text: Change the category on link {id} to {categoryId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryPersonas/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new category-persona link
      effect: read
      questions:
      - What defaults does a new category-persona assignment start with?
      - Is there an empty template for a category-persona link?
      instructions:
      - text: Get the default category-persona template.
      - text: Show prefilled defaults for a new category-persona link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categorypersonas/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove category-persona assignments
      effect: destructive
      questions:
      - Can I delete many category-persona links in one call?
      - How do I bulk untarget categories from personas?
      instructions:
      - text: Bulk delete category-persona assignments {ids}.
        slots:
          ids: query.ids
      - text: Remove the category-persona links with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categorypersonas({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a category-persona link
      effect: read
      questions:
      - Can I read a custom property on a category-persona assignment?
      - Where do extra fields for a category-persona link live?
      instructions:
      - text: Show custom property {property} on category-persona link {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get assignment {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'