Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely CMP Open API Documentation Brand Compliance API

4 actions 4 updates phrasing extends openapi/optimizely-brand-compliance-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 4

$.info

$.paths['/tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance'].get

$.paths['/tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance'].put

$.paths['/brand-compliance/categories'].get

OpenAPI Overlay

# 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 Brand Compliance API
  version: 1.0.0
extends: openapi/optimizely-brand-compliance-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: 3
- target: $.paths['/tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a draft's brand compliance check
      effect: read
      questions:
      - Did this asset draft pass the brand compliance review?
      - Which compliance categories flagged a draft of a task asset?
      instructions:
      - text: Get brand compliance for draft {draft_id} of asset {asset_id} on task {task_id}.
        slots:
          task_id: path.task_id
          asset_id: path.asset_id
          draft_id: path.draft_id
      - text: Show the brand compliance result of task {task_id}, asset {asset_id}, draft {draft_id}.
        slots:
          task_id: path.task_id
          asset_id: path.asset_id
          draft_id: path.draft_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance'].put
  update:
    x-apievangelist-phrasing:
      intent: Record a draft's brand compliance result
      effect: write
      questions:
      - How do I mark an asset draft as brand compliant or not?
      - Can I set which compliance categories apply to a draft?
      instructions:
      - text: Set brand compliance of draft {draft_id} (asset {asset_id}, task {task_id}) to {status} with categories {categories}.
        slots:
          task_id: path.task_id
          asset_id: path.asset_id
          draft_id: path.draft_id
          status: requestBody.status
          categories: requestBody.categories
      - text: 'Update draft {draft_id} of asset {asset_id} in task {task_id}: compliance {status}, categories {categories}.'
        slots:
          task_id: path.task_id
          asset_id: path.asset_id
          draft_id: path.draft_id
          status: requestBody.status
          categories: requestBody.categories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brand-compliance/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand compliance categories
      effect: read
      questions:
      - What brand compliance categories can a draft be checked against?
      - Can I page through the available brand compliance categories?
      instructions:
      - text: List brand compliance categories.
      - text: Show {page_size} brand compliance categories starting at {offset}.
        slots:
          page_size: query.page_size
          offset: query.offset
      method: generated
      generated: '2026-09-26'