diff options
Diffstat (limited to 'docs/docsite/rst/rest_api/api_ref.rst')
| -rw-r--r-- | docs/docsite/rst/rest_api/api_ref.rst | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/docs/docsite/rst/rest_api/api_ref.rst b/docs/docsite/rst/rest_api/api_ref.rst new file mode 100644 index 0000000000..144d21854f --- /dev/null +++ b/docs/docsite/rst/rest_api/api_ref.rst @@ -0,0 +1,92 @@ +:orphan: + +.. _api_reference: + +AWX API Reference Guide +================================ + +The API Reference Manual provides in-depth documentation for the AWX REST API, including integration examples. + +.. raw:: html + + <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0"> + <defs> + <symbol viewBox="0 0 20 20" id="unlocked"> + <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path> + </symbol> + + <symbol viewBox="0 0 20 20" id="locked"> + <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/> + </symbol> + + <symbol viewBox="0 0 20 20" id="close"> + <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/> + </symbol> + + <symbol viewBox="0 0 20 20" id="large-arrow"> + <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/> + </symbol> + + <symbol viewBox="0 0 20 20" id="large-arrow-down"> + <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/> + </symbol> + + + <symbol viewBox="0 0 24 24" id="jump-to"> + <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/> + </symbol> + + <symbol viewBox="0 0 24 24" id="expand"> + <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/> + </symbol> + + </defs> + </svg> + <div id="swagger-ui"></div> + <script src="../_static/swagger-ui-bundle.js"></script> + <script src="../_static/swagger-ui-standalone-preset.js"></script> + <script> + window.onload = function() { + $('head').append('<link rel="stylesheet" href="../_static/swagger-ui.css" type="text/css"></link>'); + $('head').append('<link rel="stylesheet" href="../_static/tower.css" type="text/css"></link>'); + $('#swagger-ui').on('click', function(e) { + // By default, swagger-ui has a show/hide toggle for headers, and + // there's no way to turn it off; this code intercepts the click event + // higher in the DOM and disables it + var header = $(e.target).closest('.opblock-tag'); + anchor = header.find('a[href]').attr('href'); + if (anchor) { + window.location.hash = anchor.replace(' ', '_'); + e.stopPropagation(); + return false; + } + return true; + }); + + const ui = SwaggerUIBundle({ + spec: {{SPEC}}, + dom_id: '#swagger-ui', + deepLinking: true, + presets: [ + SwaggerUIBundle.presets.apis, + SwaggerUIStandalonePreset + ], + operationsSorter: function(a, b){ + // sort alphabetically by path name first, then sort by method name + var method_order = [ + 'get', 'post', 'put', 'patch', 'delete' + ]; + var compared = a.get("path").localeCompare(b.get("path")); + if(compared == 0){ + return ( + method_order.indexOf(a.get('method')) - + method_order.indexOf(b.get('method')) + ); + } + return compared; + }, + layout: "StandaloneLayout" + }); + window.ui = ui; + } + </script> |