Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Graph πŸ“ Resources API

6 actions 6 updates phrasing extends openapi/optimizely-resources-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 6

$.info
$.paths['/resources/stopwords'].put
$.paths['/resources/stopwords'].delete
$.paths['/resources/synonyms'].get
$.paths['/resources/synonyms'].put
$.paths['/resources/synonyms'].delete

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 Graph πŸ“ Resources API
  version: 1.0.0
extends: openapi/optimizely-resources-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['/resources/stopwords'].put
  update:
    x-apievangelist-phrasing:
      intent: Store search stop words
      effect: write
      questions:
      - How do I tell search to ignore common words like 'the' and 'and'?
      - Can I keep a separate stop word list per language?
      instructions:
      - text: Store my stop word list for search.
      - text: Save stop words for language {language}.
        slots:
          language: query.language_routing
      - text: Upload stop words for language {language} and source {source}.
        slots:
          language: query.language_routing
          source: query.source_routing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/stopwords'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete search stop words
      effect: destructive
      questions:
      - Can I wipe the stop word list so every word counts in search?
      - What happens if I remove the stop words for one language?
      instructions:
      - text: Delete all stored stop words.
      - text: Remove the stop words for language {language}.
        slots:
          language: query.language_routing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/synonyms'].get
  update:
    x-apievangelist-phrasing:
      intent: List search synonyms for a slot
      effect: read
      questions:
      - Which synonyms are stored for my search index?
      - Can I view the synonyms in a particular synonym slot?
      instructions:
      - text: List the stored search synonyms.
      - text: Show synonyms in slot {slot} for language {language}.
        slots:
          slot: query.synonym_slot
          language: query.language_routing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/synonyms'].put
  update:
    x-apievangelist-phrasing:
      intent: Store search synonyms
      effect: write
      questions:
      - How do I expand search queries so 'H2O' also finds 'water'?
      - Can I store synonyms in a specific slot and language?
      instructions:
      - text: Store my synonym list for search.
      - text: Save synonyms into slot {slot} for language {language}.
        slots:
          slot: query.synonym_slot
          language: query.language_routing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/synonyms'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete search synonyms
      effect: destructive
      questions:
      - Can I clear out every synonym stored for search?
      - What's the way to drop synonyms for one language only?
      instructions:
      - text: Delete all stored synonyms.
      - text: Remove synonyms for language {language} from source {source}.
        slots:
          language: query.language_routing
          source: query.source_routing
      method: generated
      generated: '2026-09-26'