Acquia · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Acquia Cloud API Documentation Account API
28 actions
28 updates
phrasing
extends
openapi/acquia-account-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.
What the actions change
x-apievangelist-phrasing
Targets 28 · first 16 shown; the file carries all of them
$.info
$.paths['/account'].get
$.paths['/account/applications/{applicationUuid}/has-permission'].get
$.paths['/account/applications/{applicationUuid}/is-admin'].get
$.paths['/account/applications/{applicationUuid}/is-owner'].get
$.paths['/account/applications/{applicationUuid}/actions/mark-recent'].post
$.paths['/account/applications/{applicationUuid}/actions/star'].post
$.paths['/account/applications/{applicationUuid}/actions/unstar'].post
$.paths['/account/drush-aliases/download'].get
$.paths['/account/ides'].get
$.paths['/account/invites'].get
$.paths['/account/messages'].get
$.paths['/account/organizations/{organizationUuid}/is-admin'].get
$.paths['/account/organizations/{organizationUuid}/is-owner'].get
$.paths['/account/password'].post
$.paths['/account/ssh-keys'].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 Account API
version: 1.0.0
extends: openapi/acquia-account-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: 27
- target: $.paths['/account'].get
update:
x-apievangelist-phrasing:
intent: Get my account details
effect: read
questions:
- What does Acquia have on file for my user account?
- Where can I see my starred and recently viewed applications?
instructions:
- text: Show my account details.
- text: Get my profile, including starred and recent applications.
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/has-permission'].get
update:
x-apievangelist-phrasing:
intent: Check if I have a permission on an application
effect: read
questions:
- Am I allowed to perform a specific action on an application?
- Can I check whether I hold one named permission for an app?
instructions:
- text: Check whether I have permission {permission} on application {applicationUuid}.
slots:
permission: query.permission
applicationUuid: path.applicationUuid
- text: Do I hold {permission} for application {applicationUuid}? Verify it.
slots:
permission: query.permission
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/is-admin'].get
update:
x-apievangelist-phrasing:
intent: Check if I administer an application
effect: read
questions:
- Am I an administrator of this application?
- Can I confirm my admin status on an app?
instructions:
- text: Check whether I am an administrator of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Confirm my admin rights on application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/is-owner'].get
update:
x-apievangelist-phrasing:
intent: Check if I own an application
effect: read
questions:
- Am I the owner of this application?
- Can I verify application ownership for my account?
instructions:
- text: Check whether I own application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Confirm I am the owner of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/actions/mark-recent'].post
update:
x-apievangelist-phrasing:
intent: Mark an application as recently viewed
effect: write
questions:
- How do I add an app to my recently viewed list?
- Can I record that I just looked at an application?
instructions:
- text: Mark application {applicationUuid} as recently viewed.
slots:
applicationUuid: path.applicationUuid
- text: Add application {applicationUuid} to my recent applications.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/actions/star'].post
update:
x-apievangelist-phrasing:
intent: Star an application
effect: write
questions:
- How do I favorite an application so it's easy to find?
- Can I star an app on my account?
instructions:
- text: Star application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Add application {applicationUuid} to my starred list.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/applications/{applicationUuid}/actions/unstar'].post
update:
x-apievangelist-phrasing:
intent: Unstar an application
effect: write
questions:
- Can I remove an app from my favorites?
- How do I unstar an application?
instructions:
- text: Unstar application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Take application {applicationUuid} off my starred list.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/drush-aliases/download'].get
update:
x-apievangelist-phrasing:
intent: Download my Drush aliases
effect: read
questions:
- Where can I download Drush aliases for all my sites?
- Can I get Drush alias files for a specific Drush version?
instructions:
- text: Download my Drush aliases for Drush version {version}.
slots:
version: query.version
- text: Get the compressed Drush alias archive, version {version}.
slots:
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/account/ides'].get
update:
x-apievangelist-phrasing:
intent: List my Cloud IDEs
effect: read
questions:
- Which Cloud IDEs do I personally own?
- Can I see all of my own IDEs across applications?
instructions:
- text: List my Cloud IDEs.
- text: Show every IDE assigned to me.
method: generated
generated: '2026-09-26'
- target: $.paths['/account/invites'].get
update:
x-apievangelist-phrasing:
intent: List my pending invitations
effect: read
questions:
- Do I have any pending team or organization admin invites?
- Can I filter the invitations waiting for me by who sent them?
instructions:
- text: List my pending invitations.
- text: Show my pending invites matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/account/messages'].get
update:
x-apievangelist-phrasing:
intent: List messages for my account
effect: read
questions:
- What platform messages are addressed to me?
- Can I filter my own messages by type?
instructions:
- text: List my account messages.
- text: Show my messages from {from} to {to}.
slots:
from: query.from
to: query.to
method: generated
generated: '2026-09-26'
- target: $.paths['/account/organizations/{organizationUuid}/is-admin'].get
update:
x-apievangelist-phrasing:
intent: Check if I administer an organization
effect: read
questions:
- Am I an organization administrator?
- Can I confirm admin rights on an organization?
instructions:
- text: Check whether I am an administrator of organization {organizationUuid}.
slots:
organizationUuid: path.organizationUuid
- text: Confirm my admin status in organization {organizationUuid}.
slots:
organizationUuid: path.organizationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/organizations/{organizationUuid}/is-owner'].get
update:
x-apievangelist-phrasing:
intent: Check if I own an organization
effect: read
questions:
- Am I the owner of this organization?
- Can I verify organization ownership for my account?
instructions:
- text: Check whether I own organization {organizationUuid}.
slots:
organizationUuid: path.organizationUuid
- text: Confirm I am the owner of organization {organizationUuid}.
slots:
organizationUuid: path.organizationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/password'].post
update:
x-apievangelist-phrasing:
intent: Verify my current password
effect: read
questions:
- Can I confirm that a password matches my account before a sensitive action?
- Is there a way to check my current password is correct?
instructions:
- text: Verify that {password} is my current password.
slots:
password: requestBody.password
- text: Check my account password against {password}.
slots:
password: requestBody.password
method: generated
generated: '2026-09-26'
- target: $.paths['/account/ssh-keys'].get
update:
x-apievangelist-phrasing:
intent: List my SSH keys
effect: read
questions:
- Which SSH keys are installed on my account?
- Can I search my SSH keys by label?
instructions:
- text: List my SSH keys.
- text: Show my SSH keys matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/account/ssh-keys'].post
update:
x-apievangelist-phrasing:
intent: Add an SSH key to my account
effect: write
questions:
- How do I upload a new public SSH key?
- Can I label an SSH key when I add it?
instructions:
- text: Install SSH key {public_key} labeled {label} on my account.
slots:
public_key: requestBody.public_key
label: requestBody.label
- text: Add a new SSH key called {label} with public key {public_key}.
slots:
label: requestBody.label
public_key: requestBody.public_key
method: generated
generated: '2026-09-26'
- target: $.paths['/account/ssh-keys/{sshKeyUuid}'].get
update:
x-apievangelist-phrasing:
intent: Get one of my SSH keys
effect: read
questions:
- What's the fingerprint of a particular SSH key I added?
- Can I look up one SSH key by its UUID?
instructions:
- text: Show SSH key {sshKeyUuid}.
slots:
sshKeyUuid: path.sshKeyUuid
- text: Get the details of my SSH key {sshKeyUuid}.
slots:
sshKeyUuid: path.sshKeyUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/ssh-keys/{sshKeyUuid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an SSH key
effect: destructive
questions:
- How do I remove an old SSH key from my account?
- Can I delete an SSH key that may be compromised?
instructions:
- text: Delete SSH key {sshKeyUuid}.
slots:
sshKeyUuid: path.sshKeyUuid
- text: Remove SSH key {sshKeyUuid} from my account.
slots:
sshKeyUuid: path.sshKeyUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/subscriptions/{subscriptionUuid}/is-admin'].get
update:
x-apievangelist-phrasing:
intent: Check if I administer a subscription
effect: read
questions:
- Am I an administrator on this subscription?
- Can I confirm my subscription admin rights?
instructions:
- text: Check whether I am an administrator of subscription {subscriptionUuid}.
slots:
subscriptionUuid: path.subscriptionUuid
- text: Confirm my admin status on subscription {subscriptionUuid}.
slots:
subscriptionUuid: path.subscriptionUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/subscriptions/{subscriptionUuid}/is-owner'].get
update:
x-apievangelist-phrasing:
intent: Check if I own a subscription
effect: read
questions:
- Am I the owner of this subscription?
- Can I verify subscription ownership for my account?
instructions:
- text: Check whether I own subscription {subscriptionUuid}.
slots:
subscriptionUuid: path.subscriptionUuid
- text: Confirm I am the owner of subscription {subscriptionUuid}.
slots:
subscriptionUuid: path.subscriptionUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/teams/{teamUuid}/has-permission'].get
update:
x-apievangelist-phrasing:
intent: Check if I have a permission on a team
effect: read
questions:
- Do I hold a specific permission within a team?
- Can I check one named team permission for my account?
instructions:
- text: Check whether I have permission {permission} on team {teamUuid}.
slots:
permission: query.permission
teamUuid: path.teamUuid
- text: Verify I hold {permission} in team {teamUuid}.
slots:
permission: query.permission
teamUuid: path.teamUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/teams/{teamUuid}/is-admin'].get
update:
x-apievangelist-phrasing:
intent: Check if I administer a team
effect: read
questions:
- Am I an administrator of this team?
- Can I confirm team admin rights for my account?
instructions:
- text: Check whether I am an administrator of team {teamUuid}.
slots:
teamUuid: path.teamUuid
- text: Confirm my admin status in team {teamUuid}.
slots:
teamUuid: path.teamUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/teams/{teamUuid}/is-owner'].get
update:
x-apievangelist-phrasing:
intent: Check if I own a team
effect: read
questions:
- Am I the owner of this team?
- Can I verify team ownership for my account?
instructions:
- text: Check whether I own team {teamUuid}.
slots:
teamUuid: path.teamUuid
- text: Confirm I am the owner of team {teamUuid}.
slots:
teamUuid: path.teamUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/tokens'].get
update:
x-apievangelist-phrasing:
intent: List my API access tokens
effect: read
questions:
- Which API tokens have I created on my account?
- Can I audit my API tokens without seeing the secrets?
instructions:
- text: List my API access tokens.
- text: Show metadata for every API token tied to my account.
method: generated
generated: '2026-09-26'
- target: $.paths['/account/tokens'].post
update:
x-apievangelist-phrasing:
intent: Create an API access token
effect: write
questions:
- How do I generate a new API token for scripts?
- Can I name an API token when I create it?
instructions:
- text: Create an API access token labeled {label}.
slots:
label: requestBody.label
- text: Generate a new API token for my account called {label}.
slots:
label: requestBody.label
method: generated
generated: '2026-09-26'
- target: $.paths['/account/tokens/{tokenUuid}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one API token
effect: read
questions:
- When was a particular API token created or last used?
- Can I look up one of my API tokens by UUID?
instructions:
- text: Show API token {tokenUuid}.
slots:
tokenUuid: path.tokenUuid
- text: Get the details of my access token {tokenUuid}.
slots:
tokenUuid: path.tokenUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/account/tokens/{tokenUuid}'].delete
update:
x-apievangelist-phrasing:
intent: Revoke an API access token
effect: destructive
questions:
- How do I revoke an API token that leaked?
- Can I record a reason when I revoke an access token?
instructions:
- text: Revoke API token {tokenUuid}.
slots:
tokenUuid: path.tokenUuid
- text: Revoke access token {tokenUuid} with reason {tokenDeleteReason}.
slots:
tokenUuid: path.tokenUuid
tokenDeleteReason: query.tokenDeleteReason
method: generated
generated: '2026-09-26'