dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST System Monitoring API

3 actions 3 updates phrasing extends openapi/dotcms-system-monitoring-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for dotCMS's API. It is a proposal applied on top of the contract, not a document dotCMS publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

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

$.paths['/api/v1/{a}/{a}'].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 dotCMS REST System Monitoring API
  version: 1.0.0
extends: openapi/dotcms-system-monitoring-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/{a}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a full system health check
      effect: read
      questions:
      - Is my dotCMS instance passing its deeper health check?
      - Which monitoring endpoint runs the heavier health check?
      instructions:
      - text: Run the full system health check.
      - text: Run the heavy health check against this dotCMS instance and report the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/{a}/{a}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if the server is ready
      effect: read
      questions:
      - Is the server ready to take traffic yet?
      - Can a load balancer probe dotCMS for readiness?
      instructions:
      - text: Check whether the server is ready.
      - text: Probe the readiness endpoint before routing traffic.
      method: generated
      generated: '2026-09-26'