Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conversion Management Health Check API

3 actions 3 updates phrasing extends openapi/conga-health-check-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/conversion-management/v1/health/live'].get

$.paths['/api/conversion-management/v1/health/ready'].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 Conversion Management Health Check API
  version: 1.0.0
extends: openapi/conga-health-check-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/conversion-management/v1/health/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service liveness
      effect: read
      questions:
      - Is the conversion management service alive?
      - Can I ping the conversion service for liveness?
      instructions:
      - text: Check whether the conversion service is live.
      - text: Run the liveness probe.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/conversion-management/v1/health/ready'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service readiness
      effect: read
      questions:
      - Is the conversion service ready to take requests?
      - Can I run a deep readiness check on dependencies?
      instructions:
      - text: Check whether the conversion service is ready.
      - text: Run a readiness check with deep check {deep}.
        slots:
          deep: query.deepCheck
      method: generated
      generated: '2026-10-01'