Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Jobquotes API

4 actions 4 updates phrasing extends openapi/optimizely-jobquotes-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/jobquotes'].get

$.paths['/api/v1/jobquotes/{jobQuoteId}'].get

$.paths['/api/v1/jobquotes/{jobQuoteId}'].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 Jobquotes API
  version: 1.0.0
extends: openapi/optimizely-jobquotes-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/jobquotes'].get
  update:
    x-apievangelist-phrasing:
      intent: List job quotes
      effect: read
      questions:
      - Which job quotes are available to my account?
      - Can I page through job quotes a set number at a time?
      instructions:
      - text: List my job quotes.
      - text: Show page {page} of job quotes with {pageSize} per page.
        slots:
          page: query.parameter.page
          pageSize: query.parameter.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/jobquotes/{jobQuoteId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job quote
      effect: read
      questions:
      - Can I see the lines, total and expiration date of a specific job quote?
      - Is a particular job quote still editable?
      instructions:
      - text: Get job quote {jobQuoteId}.
        slots:
          jobQuoteId: path.jobQuoteId
      - text: Show the line items and expiration of job quote {jobQuoteId}.
        slots:
          jobQuoteId: path.jobQuoteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/jobquotes/{jobQuoteId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a job quote
      effect: write
      questions:
      - How do I change the job name or notes on a job quote?
      - Can I update the quote lines on an existing job quote?
      instructions:
      - text: Rename job quote {jobQuoteId} to {jobName}.
        slots:
          jobQuoteId: path.jobQuoteId
          jobName: requestBody.jobName
      - text: Add the note {notes} to job quote {jobQuoteId}.
        slots:
          notes: requestBody.notes
          jobQuoteId: path.jobQuoteId
      method: generated
      generated: '2026-09-26'