Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Agreements API

6 actions 6 updates phrasing extends openapi/acquia-agreements-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 6

$.info

$.paths['/agreements'].get

$.paths['/agreements/{agreementUuid}'].get

$.paths['/agreements/{agreementUuid}/actions/accept'].post

$.paths['/agreements/{agreementUuid}/actions/decline'].post

$.paths['/agreements/{agreementUuid}/invitees'].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 Acquia Cloud API Documentation Agreements API
  version: 1.0.0
extends: openapi/acquia-agreements-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: 5
- target: $.paths['/agreements'].get
  update:
    x-apievangelist-phrasing:
      intent: List legal agreements awaiting my response
      effect: read
      questions:
      - Which Acquia legal agreements have I been invited to accept or decline?
      - Are there any pending agreements waiting on my signature?
      instructions:
      - text: List every agreement I've been invited to accept or decline.
      - text: Show me all the legal agreements waiting on my decision.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agreements/{agreementUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View the details of one legal agreement
      effect: read
      questions:
      - What does a specific agreement I was invited to actually say?
      - Can I read the full details of one agreement before accepting it?
      instructions:
      - text: Show me the details of agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      - text: Open agreement {agreement} so I can review its terms.
        slots:
          agreement: path.agreementUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agreements/{agreementUuid}/actions/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a legal agreement
      effect: write
      questions:
      - How do I accept a legal agreement I've been invited to?
      - Can I sign off on an agreement through the API instead of the UI?
      instructions:
      - text: Accept agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      - text: Agree to the terms of legal agreement {agreement} on my behalf.
        slots:
          agreement: path.agreementUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agreements/{agreementUuid}/actions/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline a legal agreement
      effect: destructive
      questions:
      - What happens if I want to reject an agreement I was invited to?
      - Can I turn down a legal agreement rather than accepting it?
      instructions:
      - text: Decline agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      - text: Reject the terms of legal agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agreements/{agreementUuid}/invitees'].get
  update:
    x-apievangelist-phrasing:
      intent: List users invited to act on an agreement
      effect: read
      questions:
      - Who else has been invited to accept or decline this agreement?
      - Which users are on the invitee list for a given agreement?
      instructions:
      - text: List the users invited to action agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      - text: Show me who was asked to sign agreement {agreement}.
        slots:
          agreement: path.agreementUuid
      method: generated
      generated: '2026-09-26'