Red Hat Ansible Automation Platform · OpenAPI Overlay 1.0.0

API Evangelist overlay — Red Hat Ansible Automation Controller API

3 actions 3 updates servers extends openapi/red-hat-ansible-automation-platform-automation-controller-openapi.json

Generated by API Evangelist Written by API Evangelist tooling for Red Hat Ansible Automation Platform's API. It is a proposal applied on top of the contract, not a document Red Hat Ansible Automation Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-api-evangelist-productx-api-evangelist-noteserverscomponents

Targets 2

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay — Red Hat Ansible Automation Controller API
  version: 1.0.0
extends: openapi/red-hat-ansible-automation-platform-automation-controller-openapi.json
x-generated: '2026-08-29'
x-method: generated
x-source: openapi/red-hat-ansible-automation-platform-automation-controller-openapi.json plus openapi/_sources.yml
x-finding: The document titles itself "AWX API" — AWX is the upstream project; the productized component
  is Automation Controller. It declares no servers[] block and no securitySchemes, and carries x-ai-description
  on 630 of 632 operations but `summary` on none.
x-note: This overlay records API Evangelist enhancements only. It is never applied to the harvested document,
  which is kept verbatim.
actions:
- target: $.info
  update:
    x-api-evangelist-product: Red Hat Ansible Automation Platform — Automation Controller
    x-api-evangelist-note: Productized as Automation Controller; AWX is the upstream community project.
- target: $
  update:
    servers:
    - url: https://{aap-gateway-host}/api/controller/v2
      description: Automation Controller behind the AAP 2.5+ Platform Gateway on the customer installation
      variables:
        aap-gateway-host:
          default: aap.example.com
          description: The customer AAP Gateway hostname
- target: $
  update:
    components:
      securitySchemes:
        oauth2:
          type: oauth2
          description: Documented by the Platform Gateway; not declared in this document.
          flows:
            authorizationCode:
              authorizationUrl: /o/authorize/
              tokenUrl: /o/token/
              scopes:
                read: Read access to resources
                write: Write access to resources (includes read)
        basicAuth:
          type: http
          scheme: basic
        tokenAuth:
          type: http
          scheme: bearer
          description: AAP personal or application OAuth token