# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely CMP Open API Documentation Publishing API
  version: 1.0.0
extends: openapi/optimizely-publishing-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: 5
- target: $.paths['/publishing-channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List publishing channels
      effect: read
      questions:
      - Which publishing channels are available in my Optimizely CMP organization?
      - What channels can I pick from before creating a publishing intent for a task?
      instructions:
      - text: List the organization's publishing channels.
      - text: Show publishing channels, {page_size} per page starting at {offset}.
        slots:
          page_size: query.page_size
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publishing-events/{publishing_event_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a publishing event
      effect: read
      questions:
      - What are the details of a specific publishing event?
      - Can I look up one publishing event by its ID?
      instructions:
      - text: Show publishing event {publishing_event_id}.
        slots:
          publishing_event_id: path.publishing_event_id
      - text: Get the details of publishing event {publishing_event_id}.
        slots:
          publishing_event_id: path.publishing_event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publishing-events/{publishing_event_id}/publishing-metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset publishing metadata for an event
      effect: read
      questions:
      - Which assets in a publishing event failed or succeeded to publish?
      - Can I filter a publishing event's asset metadata by locale or asset type?
      instructions:
      - text: List publishing metadata for every asset in event {publishing_event_id}.
        slots:
          publishing_event_id: path.publishing_event_id
      - text: List assets in publishing event {publishing_event_id} with status {status} for locale {locale}.
        slots:
          publishing_event_id: path.publishing_event_id
          status: query.status
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publishing-events/{publishing_event_id}/publishing-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Record publishing metadata for assets in bulk
      effect: write
      questions:
      - How do I report publishing results for many assets of an event at once?
      - Can I post asset publishing metadata in bulk for one publishing event?
      instructions:
      - text: Create publishing metadata {data} for event {publishing_event_id}.
        slots:
          data: requestBody.data
          publishing_event_id: path.publishing_event_id
      - text: Bulk record the asset publish results {data} on publishing event {publishing_event_id}.
        slots:
          data: requestBody.data
          publishing_event_id: path.publishing_event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publishing-events/{publishing_event_id}/assets/{asset_id}/publishing-metadata/{publishing_metadata_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one asset's publishing metadata
      effect: read
      questions:
      - Where can I see the publishing metadata record for one asset in an event?
      - Can I fetch a single publishing metadata entry for a specific asset?
      instructions:
      - text: Show publishing metadata {publishing_metadata_id} for asset {asset_id} in event {publishing_event_id}.
        slots:
          publishing_metadata_id: path.publishing_metadata_id
          asset_id: path.asset_id
          publishing_event_id: path.publishing_event_id
      - text: Get how asset {asset_id} was published in event {publishing_event_id}, metadata {publishing_metadata_id}.
        slots:
          asset_id: path.asset_id
          publishing_event_id: path.publishing_event_id
          publishing_metadata_id: path.publishing_metadata_id
      method: generated
      generated: '2026-09-26'