Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Cloud IDE API

3 actions 3 updates phrasing extends openapi/acquia-cloud-ide-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['/ides/{ideUuid}'].get
$.paths['/ides/{ideUuid}'].delete

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 Cloud IDE API
  version: 1.0.0
extends: openapi/acquia-cloud-ide-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['/ides/{ideUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Cloud IDE details
      effect: read
      questions:
      - What's the status and URL of a specific Cloud IDE?
      - Can I look up a Cloud IDE by its UUID?
      instructions:
      - text: Show Cloud IDE {ideUuid}.
        slots:
          ideUuid: path.ideUuid
      - text: Get the details of IDE {ideUuid}.
        slots:
          ideUuid: path.ideUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ides/{ideUuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: De-provision a Cloud IDE
      effect: destructive
      questions:
      - How do I delete a Cloud IDE I'm done with?
      - Can I de-provision an IDE to free it up?
      instructions:
      - text: De-provision Cloud IDE {ideUuid}.
        slots:
          ideUuid: path.ideUuid
      - text: Delete IDE {ideUuid}.
        slots:
          ideUuid: path.ideUuid
      method: generated
      generated: '2026-09-26'