# 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 Health API
  version: 1.0.0
extends: openapi/dotcms-health-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: 8
- target: $.paths['/api/v1/health/check/{checkName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of one health check
      effect: read
      questions:
      - Is the database health check passing right now?
      - Can I check just one component's health instead of everything?
      instructions:
      - text: Show the result of health check {checkName}.
        slots:
          checkName: path.checkName
      - text: Check whether {checkName} is healthy.
        slots:
          checkName: path.checkName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the registered health checks
      effect: read
      questions:
      - Which health checks are registered on my dotCMS server?
      - What check names can I query individually?
      instructions:
      - text: List all health check names.
      - text: Show me which health checks exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/liveness'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed liveness health
      effect: read
      questions:
      - Is the dotCMS application alive, with details per critical component?
      - Which endpoint gives liveness details suited for a dashboard?
      instructions:
      - text: Show the liveness health details.
      - text: Check if the app is alive and list the critical component results.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full health report
      effect: read
      questions:
      - What is the overall health of my dotCMS instance across all checks?
      - Does the detailed health report require authentication?
      instructions:
      - text: Give me the complete health report with every check.
      - text: Show overall system health.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/readiness'].get
  update:
    x-apievangelist-phrasing:
      intent: Get readiness health for traffic
      effect: read
      questions:
      - Is this dotCMS node ready to receive traffic yet?
      - Which components are blocking readiness after a restart?
      instructions:
      - text: Show readiness health details.
      - text: Check if the server is ready to take traffic.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quick alive and ready summary
      effect: read
      questions:
      - Can I get a simple yes or no on whether dotCMS is alive and ready?
      - What's the lightest health endpoint for a quick status check?
      instructions:
      - text: Give me the alive and ready flags.
      - text: Show a one-line system status summary.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/refresh/{checkName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Force a refresh of one health check
      effect: write
      questions:
      - Can I rerun a single health check right now instead of waiting for the cache?
      - How do I get a fresh result for one component after maintenance?
      instructions:
      - text: Refresh health check {checkName} now.
        slots:
          checkName: path.checkName
      - text: Rerun {checkName} bypassing the cache.
        slots:
          checkName: path.checkName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/health/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Force a refresh of all health checks
      effect: write
      questions:
      - How do I rerun every health check after a configuration change?
      - Can I bypass cached health results for all components at once?
      instructions:
      - text: Refresh all health checks now.
      - text: Rerun every registered health check without cache.
      method: generated
      generated: '2026-09-26'