Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Website Languages API

10 actions 10 updates phrasing extends openapi/optimizely-website-languages-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/WebsiteLanguages'].get
$.paths['/api/v1/admin/WebsiteLanguages'].post
$.paths['/api/v1/admin/WebsiteLanguages({id})'].get
$.paths['/api/v1/admin/WebsiteLanguages({id})'].put
$.paths['/api/v1/admin/WebsiteLanguages({id})'].delete
$.paths['/api/v1/admin/WebsiteLanguages({id})'].patch
$.paths['/api/v1/admin/WebsiteLanguages/Default.Default()'].get
$.paths['/api/v1/admin/websitelanguages/delete'].delete
$.paths['/api/v1/admin/websitelanguages({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 Website Languages API
  version: 1.0.0
extends: openapi/optimizely-website-languages-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/WebsiteLanguages'].get
  update:
    x-apievangelist-phrasing:
      intent: List website languages
      effect: read
      questions:
      - Which languages are enabled on each of my storefront websites?
      - Can I list only the live languages for a website?
      instructions:
      - text: List all website languages.
      - text: List website languages matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a language to a website
      effect: write
      questions:
      - How do I enable a new language on a storefront website?
      - Can I add a language to a website and make it the default?
      instructions:
      - text: Add language {languageId} to website {websiteId}.
        slots:
          languageId: requestBody.languageId
          websiteId: requestBody.websiteId
      - text: Add language {languageId} to website {websiteId} as default {isDefault} and live {isLive}.
        slots:
          languageId: requestBody.languageId
          websiteId: requestBody.websiteId
          isDefault: requestBody.isDefault
          isLive: requestBody.isLive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website language
      effect: read
      questions:
      - How do I check whether one website language is live?
      - Is a specific website language the default?
      instructions:
      - text: Get website language {id}.
        slots:
          id: path.id
      - text: Show if website language {id} is live and default.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website language
      effect: write
      questions:
      - How do I overwrite a website language record completely?
      - Can I repoint a website language record to another language in one call?
      instructions:
      - text: Replace website language {id} with website {websiteId} and language {languageId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          languageId: requestBody.languageId
      - text: Fully overwrite website language {id} with live {isLive}.
        slots:
          id: path.id
          isLive: requestBody.isLive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a language from a website
      effect: destructive
      questions:
      - How do I remove a language from a storefront website?
      - Can I delete a website language only if its ETag matches?
      instructions:
      - text: Delete website language {id}.
        slots:
          id: path.id
      - text: Delete website language {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a website language
      effect: write
      questions:
      - How do I take a website language live?
      - Can I make an existing website language the default?
      instructions:
      - text: Set website language {id} live to {isLive}.
        slots:
          id: path.id
          isLive: requestBody.isLive
      - text: Make website language {id} default {isDefault}.
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteLanguages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default website language template
      effect: read
      questions:
      - What default values does a new website language start with?
      - Where can I get a blank website language record?
      instructions:
      - text: Get the default website language template.
      - text: Show default values for a new website language.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitelanguages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete website languages
      effect: destructive
      questions:
      - How do I remove several website languages at once?
      - Can I bulk delete website language records by id?
      instructions:
      - text: Delete website languages {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove website language records {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitelanguages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website language custom property
      effect: read
      questions:
      - How do I read a custom property on a website language?
      - Where is one custom property value for a website language?
      instructions:
      - text: Get custom property {custompropertyKey} of website language {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show website language {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'