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

# 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'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/optimizely-checks-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.