Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Settings API

11 actions 11 updates phrasing extends openapi/optimizely-settings-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 11

$.info
$.paths['/api/v1/settings/website'].get
$.paths['/api/v1/settings/quote'].get
$.paths['/api/v1/settings/cart'].get
$.paths['/api/v1/settings/account'].get
$.paths['/api/v1/settings/wishlist'].get
$.paths['/api/v1/settings'].get
$.paths['/api/v1/settings/products'].get
$.paths['/api/v1/settings/mobileapp'].get
$.paths['/settings'].get
$.paths['/settings'].post

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 Optimizely Settings API
  version: 1.0.0
extends: openapi/optimizely-settings-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: 10
- target: $.paths['/api/v1/settings/website'].get
  update:
    x-apievangelist-phrasing:
      intent: Get storefront website settings
      effect: read
      questions:
      - What website-level settings is my commerce storefront running with?
      - Where can I read the site-wide configuration for the current website?
      instructions:
      - text: Get the website settings for the storefront.
      - text: Show the current website's configuration settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/quote'].get
  update:
    x-apievangelist-phrasing:
      intent: Get quote settings
      effect: read
      questions:
      - What are the request-for-quote settings on my storefront?
      - Can I check how quoting is configured before building an RFQ screen?
      instructions:
      - text: Get the quote settings.
      - text: Show how requests for quote are configured on the site.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/cart'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cart settings
      effect: read
      questions:
      - What cart and checkout settings are enabled on the storefront?
      - Where do I read the shopping cart configuration?
      instructions:
      - text: Get the cart settings.
      - text: Show the storefront's shopping cart configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account settings
      effect: read
      questions:
      - What user account and sign-up settings does the storefront use?
      - Can I read the account configuration the site applies to shoppers?
      instructions:
      - text: Get the account settings.
      - text: Show the storefront's user account configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/wishlist'].get
  update:
    x-apievangelist-phrasing:
      intent: Get wish list settings
      effect: read
      questions:
      - How are wish lists configured on my storefront?
      - Are shared wish lists enabled according to the site settings?
      instructions:
      - text: Get the wish list settings.
      - text: Show the storefront's wish list configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all storefront settings
      effect: read
      questions:
      - Can I pull every storefront settings group in one request?
      - What is the full combined settings collection for my commerce site?
      instructions:
      - text: Get the full storefront settings collection.
      - text: Fetch all commerce settings groups at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product settings
      effect: read
      questions:
      - What product catalog display settings does the storefront have?
      - How are product listings configured on my site?
      instructions:
      - text: Get the product settings.
      - text: Show the storefront's product catalog configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/settings/mobileapp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get mobile app settings
      effect: read
      questions:
      - What settings does the commerce mobile app pull from the server?
      - Where can I read the configuration for the mobile app?
      instructions:
      - text: Get the mobile app settings.
      - text: Show the configuration served to the commerce mobile app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Export labels, workflows and other settings
      effect: read
      questions:
      - How do I export my labels, custom fields, workflows and webhooks as one settings bundle?
      - Which routing rules and templates are in my current settings export?
      instructions:
      - text: Export the experimental settings bundle of labels, custom fields, workflows and webhooks.
      - text: Show my current routing rules, templates and apps settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Import labels, workflows and other settings
      effect: write
      questions:
      - Can I preview a settings import before it actually changes anything?
      - Will importing settings overwrite my existing workflows?
      - What happens to labels with the same name when I import a settings bundle?
      instructions:
      - text: Import labels {labels}, custom fields {custom_fields} and webhooks {webhooks} into my settings.
        slots:
          labels: requestBody.labels
          custom_fields: requestBody.custom_fields
          webhooks: requestBody.webhooks
      - text: Dry-run a settings import of workflows {workflows}, setting execute to {execute}.
        slots:
          workflows: requestBody.workflows
          execute: query.execute
      - text: Import workflows {workflows} and set overwrite_workflows to {overwrite_workflows}.
        slots:
          workflows: requestBody.workflows
          overwrite_workflows: query.overwrite_workflows
      method: generated
      generated: '2026-09-26'