Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Checks API

3 actions 3 updates phrasing extends openapi/optimizely-checks-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 3

$.info
$.paths['/api/v1/admin/checks/PostStart'].get
$.paths['/api/v1/admin/checks/PreStop'].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 Checks API
  version: 1.0.0
extends: openapi/optimizely-checks-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: 2
- target: $.paths['/api/v1/admin/checks/PostStart'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the post-start health check
      effect: read
      questions:
      - Is there a check that confirms the Commerce instance finished starting up?
      - What does the PostStart check endpoint report after a deployment?
      instructions:
      - text: Run the post-start check on the Commerce admin.
      - text: Confirm the site finished starting by calling the PostStart check.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/checks/PreStop'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the pre-stop check before shutdown
      effect: read
      questions:
      - Is there a check to call before shutting a Commerce instance down?
      - What does the PreStop check endpoint do?
      instructions:
      - text: Run the pre-stop check before shutting down the instance.
      - text: Call the PreStop check on the Commerce admin.
      method: generated
      generated: '2026-09-26'