Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Organizations API

28 actions 28 updates phrasing extends openapi/acquia-organizations-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 28 · first 16 shown; the file carries all of them

$.info
$.paths['/organizations'].get
$.paths['/organizations/{organizationUuid}'].get
$.paths['/organizations/{organizationUuid}'].put
$.paths['/organizations/{organizationUuid}'].delete
$.paths['/organizations/{organizationUuid}/actions/change-owner'].post
$.paths['/organizations/{organizationUuid}/actions/leave'].post
$.paths['/organizations/{organizationUuid}/admins'].get
$.paths['/organizations/{organizationUuid}/admins/{userUuid}'].get
$.paths['/organizations/{organizationUuid}/admins/{userUuid}'].delete
$.paths['/organizations/{organizationUuid}/admin-invites'].get
$.paths['/organizations/{organizationUuid}/admin-invites'].post
$.paths['/organizations/{organizationUuid}/applications'].get
$.paths['/organizations/{organizationUuid}/available-tags'].get
$.paths['/organizations/{organizationUuid}/available-tags'].post
$.paths['/organizations/{organizationUuid}/available-tags'].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 Organizations API
  version: 1.0.0
extends: openapi/acquia-organizations-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['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organizations I belong to
      effect: read
      questions:
      - Which Acquia organizations is my account part of?
      - What organizations hold my team's subscriptions?
      instructions:
      - text: List all the organizations I belong to.
      - text: Show every organization my account can see.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View details of one organization
      effect: read
      questions:
      - Who owns a specific organization and what are its details?
      - Can I pull up one organization's record by its UUID?
      instructions:
      - text: Get the details of organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show me organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an organization
      effect: write
      questions:
      - How do I change the name of my organization?
      - Can I rename an organization after it was created?
      instructions:
      - text: Rename organization {organization} to {name}.
        slots:
          organization: path.organizationUuid
          name: requestBody.name
      - text: Change the name of organization {organization} to {name}.
        slots:
          organization: path.organizationUuid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - Can I permanently delete an organization I no longer need?
      - What's involved in removing a whole organization?
      instructions:
      - text: Delete organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Permanently remove organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/actions/change-owner'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer ownership of an organization
      effect: write
      questions:
      - How do I hand ownership of my organization to another user?
      - Can I make someone else the main billing contact for an organization?
      instructions:
      - text: Make user {user} the owner of organization {organization}.
        slots:
          user: requestBody.user_uuid
          organization: path.organizationUuid
      - text: Transfer ownership of organization {organization} to {user}.
        slots:
          organization: path.organizationUuid
          user: requestBody.user_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/actions/leave'].post
  update:
    x-apievangelist-phrasing:
      intent: Leave an organization
      effect: destructive
      questions:
      - Can I remove myself from an organization I no longer work with?
      - What's the way to leave an organization with my own account?
      instructions:
      - text: Remove my account from organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Leave organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/admins'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's administrators
      effect: read
      questions:
      - Who are the administrators of my organization?
      - Can I filter an organization's admins by email or last name?
      instructions:
      - text: List the administrators of organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Find admins of organization {organization} matching {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/admins/{userUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one organization administrator
      effect: read
      questions:
      - What does the profile of a specific organization admin look like?
      - Is a particular user an administrator of this organization?
      instructions:
      - text: Show the admin profile of user {user} in organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      - text: Get administrator {user} of organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/admins/{userUuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's admin rights on an organization
      effect: destructive
      questions:
      - How do I take away someone's organization administrator role?
      - Can I demote an admin without removing them from the organization?
      instructions:
      - text: Remove {user} from the administrators of organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      - text: Revoke admin rights for user {user} on organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/admin-invites'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending admin invitations
      effect: read
      questions:
      - Which administrator invitations are still outstanding for my organization?
      - Who has been invited to become an org admin but hasn't accepted yet?
      instructions:
      - text: List the administrator invitations for organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show pending admin invites in organization {organization} sorted by {sort}.
        slots:
          organization: path.organizationUuid
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/admin-invites'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to be an organization admin
      effect: write
      questions:
      - How do I invite a colleague to administer my organization?
      - Can I send an admin invitation to an email address?
      instructions:
      - text: Invite {email} to be an administrator of organization {organization}.
        slots:
          email: requestBody.email
          organization: path.organizationUuid
      - text: Send an org admin invitation to {email} for organization {organization}.
        slots:
          email: requestBody.email
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications in an organization
      effect: read
      questions:
      - What applications belong to my organization?
      - Can I search an organization's applications by name?
      instructions:
      - text: List the applications in organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Find applications in organization {organization} matching {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/available-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List application tags available in an organization
      effect: read
      questions:
      - Which application tags are already defined in my organization?
      - What tags can I apply to applications in this organization?
      instructions:
      - text: List the available application tags in organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show every tag I can use on applications in organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/available-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags in bulk to organization resources
      effect: write
      questions:
      - Can I tag many organization resources at once?
      - How do I bulk-apply tags across my organization's resources?
      instructions:
      - text: Add tags {tags} to resources in context {context} of organization {organization}.
        slots:
          tags: requestBody.tags
          context: requestBody.context
          organization: path.organizationUuid
      - text: Bulk tag organization {organization} resources with {tags} using context {context}.
        slots:
          organization: path.organizationUuid
          tags: requestBody.tags
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/available-tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove tags in bulk from organization resources
      effect: destructive
      questions:
      - Can I strip a set of tags from many organization resources in one request?
      - What's the way to bulk-delete tags across an organization?
      instructions:
      - text: Remove tags {tags} from resources in context {context} of organization {organization}.
        slots:
          tags: requestBody.tags
          context: requestBody.context
          organization: path.organizationUuid
      - text: Bulk delete tags {tags} ({context}) in organization {organization}.
        slots:
          tags: requestBody.tags
          context: requestBody.context
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/identity-provider'].get
  update:
    x-apievangelist-phrasing:
      intent: View an organization's identity provider
      effect: read
      questions:
      - Which identity provider handles single sign-on for my organization?
      - Is SSO set up for this organization?
      instructions:
      - text: Show the identity provider for organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Get the SSO identity provider configured on organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List all members of an organization
      effect: read
      questions:
      - Who is a member of my organization across all its teams?
      - Can I filter organization members by permission or name?
      instructions:
      - text: List every member of organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Find members of organization {organization} matching {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/members/{userUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one organization member
      effect: read
      questions:
      - What does a specific member's profile in my organization show?
      - Can I look up one organization member by their user ID?
      instructions:
      - text: Show the member profile of user {user} in organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      - text: Get organization {organization} member {user}.
        slots:
          organization: path.organizationUuid
          user: path.userUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/members/{userUuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an organization
      effect: destructive
      questions:
      - How do I kick someone out of my organization entirely?
      - Can I remove a departed employee from the organization?
      instructions:
      - text: Remove member {user} from organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      - text: Take user {user} out of organization {organization} completely.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/members/{userUuid}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications a member can access
      effect: read
      questions:
      - Which applications does a particular organization member have access to?
      - What can a given user reach inside my organization?
      instructions:
      - text: List the applications member {user} can access in organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      - text: Show which apps user {user} has access to within organization {organization}.
        slots:
          user: path.userUuid
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's task notifications
      effect: read
      questions:
      - What work items and tasks have been started in my organization recently?
      - Can I filter an organization's notifications by status?
      instructions:
      - text: List the notifications for organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show organization {organization} notifications matching {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles defined in an organization
      effect: read
      questions:
      - What roles exist in my organization and what do they allow?
      - Can I see which organization roles were edited recently?
      instructions:
      - text: List the roles in organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show organization {organization} roles sorted by {sort}.
        slots:
          organization: path.organizationUuid
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role in an organization
      effect: write
      questions:
      - How do I create a custom role with specific permissions?
      - Can I define a new role for my organization's teams?
      instructions:
      - text: Create role {name} in organization {organization} with permissions {permissions}.
        slots:
          name: requestBody.name
          organization: path.organizationUuid
          permissions: requestBody.permissions
      - text: Add a {name} role to organization {organization} described as {description} with permissions {permissions}.
        slots:
          name: requestBody.name
          organization: path.organizationUuid
          description: requestBody.description
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions in an organization
      effect: read
      questions:
      - Which subscriptions does my organization own?
      - Can I find an organization's subscription by name?
      instructions:
      - text: List the subscriptions in organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Find subscriptions in organization {organization} matching {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/team-invites'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending team invitations in an organization
      effect: read
      questions:
      - Which team member invitations are still pending across my organization?
      - Who has been invited to join a team but hasn't accepted?
      instructions:
      - text: List pending team invitations across organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Show the member invites for all teams in organization {organization}.
        slots:
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams in an organization
      effect: read
      questions:
      - What teams exist in my organization?
      - Can I search an organization's teams by name?
      instructions:
      - text: List the teams in organization {organization}.
        slots:
          organization: path.organizationUuid
      - text: Find teams in organization {organization} named {filter}.
        slots:
          organization: path.organizationUuid
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationUuid}/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team in an organization
      effect: write
      questions:
      - How do I set up a new team inside my organization?
      - Can I create a team through the API?
      instructions:
      - text: Create a team called {name} in organization {organization}.
        slots:
          name: requestBody.name
          organization: path.organizationUuid
      - text: Add a new {name} team to organization {organization}.
        slots:
          name: requestBody.name
          organization: path.organizationUuid
      method: generated
      generated: '2026-09-26'