Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Content Authentication API

3 actions 3 updates phrasing extends openapi/acquia-authentication-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['/oauth/token'].post
$.paths['/oauth/authorize'].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 Content Authentication API
  version: 1.0.0
extends: openapi/acquia-authentication-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['/oauth/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an access token
      effect: write
      questions:
      - How do I get an access token for the Acquia Cloud API with my client credentials?
      - Can I exchange an authorization code or refresh token for a new access token?
      - Which grant types does the token endpoint accept?
      instructions:
      - text: Request an access token using the {grant_type} grant for client {client_id} with secret {client_secret}.
        slots:
          grant_type: requestBody.grant_type
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      - text: Exchange authorization code {code} for an access token as client {client_id} using secret {client_secret} and grant {grant_type}.
        slots:
          code: requestBody.code
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          grant_type: requestBody.grant_type
      - text: Refresh my token with refresh token {refresh_token} for client {client_id}, secret {client_secret}, grant {grant_type}.
        slots:
          refresh_token: requestBody.refresh_token
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Start the OAuth login and consent flow
      effect: read
      questions:
      - Where do I send a user so they can log in and approve my app's access?
      - What URL starts the authorization code flow and redirects back with a code?
      instructions:
      - text: Send the user to authorize client {client_id} with response type {response_type} and redirect back to {redirect_uri}.
        slots:
          client_id: query.client_id
          response_type: query.response_type
          redirect_uri: query.redirect_uri
      - text: Begin the authorization code login for client {client_id} asking for scope {scope}, response type {response_type}, returning to {redirect_uri}.
        slots:
          client_id: query.client_id
          scope: query.scope
          response_type: query.response_type
          redirect_uri: query.redirect_uri
      method: generated
      generated: '2026-09-26'