Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Graph 🏆 BestBets API

5 actions 5 updates phrasing extends openapi/optimizely-best-bets-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 5

$.info
$.paths['/api/bestbets/collection'].get
$.paths['/api/bestbets/collection'].post
$.paths['/api/bestbets/collection/{id}'].put
$.paths['/api/bestbets/collection/{id}'].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 🏆 BestBets API
  version: 1.0.0
extends: openapi/optimizely-best-bets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/api/bestbets/collection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get best bet collections
      effect: read
      questions:
      - How do I list the best bet collections that pin results in search?
      - Can I fetch one best bet collection by its id instead of all of them?
      instructions:
      - text: List all best bet collections.
      - text: Get best bet collection {id}.
        slots:
          id: query.id
      - text: Show page {page} of best bet collections.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bestbets/collection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a best bet collection
      effect: write
      questions:
      - How do I register a new best bet collection for promoted search results?
      - What does a new best bet collection need besides a title?
      instructions:
      - text: Create a best bet collection titled {title}.
        slots:
          title: requestBody.title
      - text: Register a new bestbet collection called {title}.
        slots:
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bestbets/collection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a best bet collection
      effect: write
      questions:
      - How do I change the title of an existing best bet collection?
      - Can I update a best bet collection by its id?
      instructions:
      - text: Rename best bet collection {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Update bestbet collection {id} with title {title}.
        slots:
          id: path.id
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bestbets/collection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a best bet collection
      effect: destructive
      questions:
      - How do I remove a best bet collection I no longer use?
      - Can I delete a bestbet collection by its id?
      instructions:
      - text: Delete best bet collection {id}.
        slots:
          id: path.id
      - text: Remove bestbet collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'