Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for EPiServer.ContentApi.Docs Site API

3 actions 3 updates phrasing extends openapi/optimizely-site-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/episerver/v3.0/site'].get

$.paths['/api/episerver/v3.0/site/{id}'].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 EPiServer.ContentApi.Docs Site API
  version: 1.0.0
extends: openapi/optimizely-site-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/episerver/v3.0/site'].get
  update:
    x-apievangelist-phrasing:
      intent: List CMS sites
      effect: read
      questions:
      - Which sites are configured in my Optimizely CMS instance?
      - Can the Content Delivery API return every site it serves?
      instructions:
      - text: List all sites.
      - text: Show every site defined in the CMS.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/episerver/v3.0/site/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CMS site by ID
      effect: read
      questions:
      - Can I fetch the settings of one site by its identifier?
      - What does the content API return for a single site?
      instructions:
      - text: Get site {id}.
        slots:
          id: path.id
      - text: Load the site record with identifier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'