mirror of
https://github.com/ansible/awx.git
synced 2026-02-02 18:18:12 -03:30
12a7229ee9
* Added link and ref to openAPI spec for community * Update docs/docsite/rst/contributor/openapi_link.rst Co-authored-by: Don Naro <dnaro@redhat.com> * add sphinxcontrib-redoc to requirements * sphinxcontrib.redoc configuration * create openapi directory and files * update download script for both schema files * suppress warning for redoc * update labels * fix extra closing parenthesis * update schema url * exclude doc config and download script The Sphinx configuration (conf.py) and schema download script (download-json.py) are not application logic and used only for building documentation. Coverage requirements for these files are overkill. * exclude only the sphinx config file --------- Co-authored-by: Don Naro <dnaro@redhat.com>
11 lines
518 B
ReStructuredText
11 lines
518 B
ReStructuredText
===================
|
|
AWX OpenAPI Schema
|
|
===================
|
|
|
|
This document describes the OpenAPI 3.0.3 specification for the AWX API (version v2).
|
|
|
|
This schema serves as the complete API documentation and contract for interacting programmatically with AWX, which is used for managing Ansible automation workflows, inventories, credentials, and job execution.
|
|
|
|
* `Explore the AWX OpenAPI Schema <explorer.html>`_
|
|
* `Download the AWX OpenAPI Schema <https://s3.amazonaws.com/awx-public-ci-files/awx/devel/schema.json>`_
|