Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Mobius Themes API

10 actions 10 updates phrasing extends openapi/optimizely-mobius-themes-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/MobiusThemes'].get
$.paths['/api/v1/admin/MobiusThemes'].post
$.paths['/api/v1/admin/MobiusThemes({id})'].get
$.paths['/api/v1/admin/MobiusThemes({id})'].put
$.paths['/api/v1/admin/MobiusThemes({id})'].delete
$.paths['/api/v1/admin/MobiusThemes({id})'].patch
$.paths['/api/v1/admin/MobiusThemes/Default.Default()'].get
$.paths['/api/v1/admin/mobiusthemes/delete'].delete
$.paths['/api/v1/admin/mobiusthemes({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 Mobius Themes API
  version: 1.0.0
extends: openapi/optimizely-mobius-themes-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/MobiusThemes'].get
  update:
    x-apievangelist-phrasing:
      intent: List Mobius storefront themes
      effect: read
      questions:
      - How do I list the Mobius themes configured across my commerce websites?
      - Can I filter Mobius themes to a single website?
      instructions:
      - text: List all Mobius themes.
      - text: List Mobius themes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Mobius theme for a website
      effect: write
      questions:
      - How do I save a new Mobius theme for one of my websites?
      - Can I store the theme definition as a value when creating a Mobius theme?
      instructions:
      - text: Create a Mobius theme for website {websiteId} with value {value}.
        slots:
          websiteId: requestBody.websiteId
          value: requestBody.value
      - text: Add a new Mobius theme to website {websiteId}.
        slots:
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Mobius theme
      effect: read
      questions:
      - How do I read the theme value saved for a specific Mobius theme?
      - Can I fetch a single Mobius theme by its ID?
      instructions:
      - text: Get Mobius theme {id}.
        slots:
          id: path.id
      - text: Show the theme value stored in Mobius theme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Mobius theme
      effect: write
      questions:
      - How do I overwrite an entire Mobius theme record?
      - Is there a way to fully replace a Mobius theme instead of patching it?
      instructions:
      - text: Replace Mobius theme {id} with website {websiteId} and value {value}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          value: requestBody.value
      - text: Overwrite Mobius theme {id} with a complete new record.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Mobius theme
      effect: destructive
      questions:
      - How do I remove a Mobius theme from a website?
      - Can I delete a Mobius theme only if its ETag still matches?
      instructions:
      - text: Delete Mobius theme {id}.
        slots:
          id: path.id
      - text: Remove Mobius theme {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Mobius theme's value
      effect: write
      questions:
      - How do I tweak the saved value of an existing Mobius theme?
      - Can I move a Mobius theme to a different website?
      instructions:
      - text: Update the value of Mobius theme {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Reassign Mobius theme {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MobiusThemes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank Mobius theme template
      effect: read
      questions:
      - What default values does a new Mobius theme start with?
      - Can I fetch an empty Mobius theme template before creating one?
      instructions:
      - text: Fetch the default Mobius theme template.
      - text: Show me the starting values for a new Mobius theme.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/mobiusthemes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete Mobius themes
      effect: destructive
      questions:
      - How do I delete several Mobius themes at once?
      - Can I remove a batch of Mobius themes by ID?
      instructions:
      - text: Bulk delete the Mobius themes with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these Mobius themes in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/mobiusthemes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a Mobius theme
      effect: read
      questions:
      - How do I read a custom property stored on a Mobius theme?
      - Can I fetch one extra field value from a Mobius theme?
      instructions:
      - text: Get custom property {custompropertyKey} on Mobius theme {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of theme {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'