Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Messages API

3 actions 3 updates phrasing extends openapi/acquia-messages-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 3

$.info
$.paths['/messages/{messageUuid}/actions/dismiss'].post
$.paths['/messages/{messageUuid}/actions/follow'].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 Messages API
  version: 1.0.0
extends: openapi/acquia-messages-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: 2
- target: $.paths['/messages/{messageUuid}/actions/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss an in-product message
      effect: write
      questions:
      - How do I get rid of a platform message I've already read?
      - Can I dismiss a message so it stops showing?
      instructions:
      - text: Dismiss message {messageUuid}.
        slots:
          messageUuid: path.messageUuid
      - text: Hide the in-product message {messageUuid}.
        slots:
          messageUuid: path.messageUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{messageUuid}/actions/follow'].get
  update:
    x-apievangelist-phrasing:
      intent: Follow a message's link
      effect: read
      questions:
      - Where does the link in a platform message lead?
      - Can I open the call-to-action link of a message?
      instructions:
      - text: Follow the link in message {messageUuid}.
        slots:
          messageUuid: path.messageUuid
      - text: Open the destination of in-product message {messageUuid}.
        slots:
          messageUuid: path.messageUuid
      method: generated
      generated: '2026-09-26'