Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Email API

2 actions 2 updates phrasing extends openapi/acquia-email-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/environments/{environmentId}/email'].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 Acquia Cloud API Documentation Email API
  version: 1.0.0
extends: openapi/acquia-email-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: 1
- target: $.paths['/environments/{environmentId}/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Platform Email status for an environment
      effect: read
      questions:
      - Is Platform Email turned on for my environment?
      - Can I check whether an environment is set up to send email?
      instructions:
      - text: Show the Platform Email status of environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Check whether email sending is enabled on environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'