Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Health API

3 actions 3 updates phrasing extends openapi/live-direct-marketing-online-health-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/health'].get
$.paths['/api/health/capacity'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Health API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-health-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/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service health
      effect: read
      questions:
      - Is the core service up and responding?
      - What is the basic health check endpoint?
      instructions:
      - text: Run the basic service health check.
      - text: Ping the main health endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/health/capacity'].get
  update:
    x-apievangelist-phrasing:
      intent: Check resource capacity before taking load
      effect: read
      questions:
      - Does the service have capacity to accept more work right now?
      - How do I check load admission capacity?
      instructions:
      - text: Check resource capacity for load admission.
      - text: See whether the service can take on more load.
      method: generated
      generated: '2026-10-01'