Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Open API

2 actions 2 updates phrasing extends openapi/agorapulse-open-api-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1.0/report/health'].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 Open API
  version: 1.0.0
extends: openapi/agorapulse-open-api-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: 1
- target: $.paths['/v1.0/report/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the API's health status
      effect: read
      questions:
      - Is the Agorapulse API up right now?
      - What does the health endpoint report about the API's state?
      instructions:
      - text: Check the health of the API.
      - text: Report whether the reporting API is currently healthy.
      method: generated
      generated: '2026-10-01'