diff --git a/docs/docsite/conf.py b/docs/docsite/conf.py index 74553d56b1..2a733792ed 100644 --- a/docs/docsite/conf.py +++ b/docs/docsite/conf.py @@ -5,7 +5,7 @@ import shlex from datetime import datetime from importlib import import_module -#sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger')) +sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger')) project = u'Ansible AWX' copyright = u'2023, Red Hat' @@ -35,6 +35,7 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_ansible_theme', + 'swagger', ] html_theme = 'sphinx_ansible_theme' diff --git a/docs/docsite/rst/rest_api/_swagger/tower.css b/docs/docsite/rst/rest_api/_swagger/awx-rest-api.css similarity index 100% rename from docs/docsite/rst/rest_api/_swagger/tower.css rename to docs/docsite/rst/rest_api/_swagger/awx-rest-api.css diff --git a/docs/docsite/rst/rest_api/_swagger/download-json.py b/docs/docsite/rst/rest_api/_swagger/download-json.py new file mode 100644 index 0000000000..47ded50a2a --- /dev/null +++ b/docs/docsite/rst/rest_api/_swagger/download-json.py @@ -0,0 +1,13 @@ +import requests + +url = "https://awx-public-ci-files.s3.amazonaws.com/community-docs/swagger.json" +swagger_json = "./docs/docsite/rst/rest_api/_swagger/swagger.json" + +response = requests.get(url) + +if response.status_code == 200: + with open(swagger_json, 'wb') as file: + file.write(response.content) + print(f"JSON file downloaded to {swagger_json}") +else: + print(f"Request failed with status code: {response.status_code}") diff --git a/docs/docsite/rst/rest_api/api_ref.rst b/docs/docsite/rst/rest_api/api_ref.rst index 144d21854f..5b049e6ae4 100644 --- a/docs/docsite/rst/rest_api/api_ref.rst +++ b/docs/docsite/rst/rest_api/api_ref.rst @@ -1,5 +1,3 @@ -:orphan: - .. _api_reference: AWX API Reference Guide @@ -48,7 +46,7 @@ The API Reference Manual provides in-depth documentation for the AWX REST API, i