Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Budgets API

4 actions 4 updates phrasing extends openapi/optimizely-budgets-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 4

$.info

$.paths['/api/v1/budgets'].get

$.paths['/api/v1/budgets/{fiscalYear}'].get

$.paths['/api/v1/budgets/{fiscalYear}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Storefront API V1 Budgets API
  version: 1.0.0
extends: openapi/optimizely-budgets-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: 3
- target: $.paths['/api/v1/budgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List budgets
      effect: read
      questions:
      - Which budgets are available to me in the storefront?
      - Can I see budgets for a particular ship-to address or user?
      instructions:
      - text: List my budgets.
      - text: Show budgets for ship-to {shipToId}.
        slots:
          shipToId: query.parameter.shipToId
      - text: List budgets for user profile {userProfileId}.
        slots:
          userProfileId: query.parameter.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/budgets/{fiscalYear}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the budget for a fiscal year
      effect: read
      questions:
      - What does my budget look like for a given fiscal year?
      - Can I get the full budget grid for one year?
      instructions:
      - text: Show the budget for fiscal year {fiscalYear}.
        slots:
          fiscalYear: path.fiscalYear
      - text: 'Get the {fiscalYear} budget as a full grid: {fullGrid}.'
        slots:
          fiscalYear: path.fiscalYear
          fullGrid: query.parameter.fullGrid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/budgets/{fiscalYear}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the budget for a fiscal year
      effect: write
      questions:
      - How do I change budget amounts for a fiscal year?
      - Can I update a year's budget lines for a specific ship-to?
      instructions:
      - text: Update the budget lines for fiscal year {fiscalYear} to {budgetLineCollection}.
        slots:
          fiscalYear: path.fiscalYear
          budgetLineCollection: requestBody.budgetLineCollection
      - text: Set the {fiscalYear} budget end date to {fiscalYearEndDate}.
        slots:
          fiscalYear: path.fiscalYear
          fiscalYearEndDate: requestBody.fiscalYearEndDate
      method: generated
      generated: '2026-09-26'