External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-04-18 08:20:22 -02:30
Code Issues Packages Projects Releases Wiki Activity

AC-939 Update browsable REST API branding to Tower.

Browse Source
This commit is contained in:
Chris Church
2014-01-23 05:22:55 -05:00
parent 8aa9fe9d7e
commit b6543be0cf
8 changed files with 77 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
awx/api/templates/api/_list_common.md
View File

@@ -54,7 +54,7 @@ within all designated text fields of a model.
?search=findme
_New in AWX 1.4_
_New since AWX 1.4_
## Filtering
@@ -75,7 +75,7 @@ To exclude results matching certain criteria, prefix the field parameter with
?not__field=value
(_New in AWX 1.4_) By default, all query string filters are AND'ed together, so
(_New since AWX 1.4_) By default, all query string filters are AND'ed together, so
only the results matching *all* filters will be returned. To combine results
matching *any* one of multiple criteria, prefix each query string parameter
with `or__`:
@@ -83,10 +83,10 @@ with `or__`:
?or__field=value&or__field=othervalue
?or__not__field=value&or__field=othervalue
(_New in AWX 1.5_) The default AND filtering applies all filters simultaneously
to each related object being filtered across database relationships. The chain
filter instead applies filters separately for each related object. To use,
prefix the query string parameter with `chain__`:
(_New in Ansible Tower 1.4.5_) The default AND filtering applies all filters
simultaneously to each related object being filtered across database
relationships. The chain filter instead applies filters separately for each
related object. To use, prefix the query string parameter with `chain__`:
?chain__related__field=value&chain__related__field2=othervalue
?chain__not__related__field=value&chain__related__field2=othervalue

7
awx/api/templates/api/_new_in_awx.md
View File

@@ -1,3 +1,4 @@
{% if new_in_13 %}> _New in AWX 1.3_{% endif %}
{% if new_in_14 %}> _New in AWX 1.4_{% endif %}
{% if new_in_15 %}> _New in AWX 1.5_{% endif %}
{% if new_in_13 %}> _New since AWX 1.3_{% endif %}
{% if new_in_14 %}> _New since AWX 1.4_{% endif %}
{% if new_in_145 %}> _New in Ansible Tower 1.4.5_{% endif %}
{% if new_in_15 %}> _New in Ansible Tower 1.5_{% endif %}

2
awx/api/templates/api/api_root_view.md
View File

@@ -1,4 +1,4 @@
The root of the AWX REST API.
The root of the Ansible Tower REST API.
Make a GET request to this resource to obtain information about the available
API versions.

2
awx/api/templates/api/api_v1_config_view.md
View File

@@ -9,4 +9,4 @@ the following fields (some fields may not be visible to all users):
use when creating/editing a project.
* `time_zone`: The configured time zone for the server.
* `license_info`: Information about the current license.
* `version`: Version of AWX package installed.
* `version`: Version of Ansible Tower (AWX) package installed.

2
awx/api/templates/api/api_v1_root_view.md
View File

@@ -1,4 +1,4 @@
Version 1 of the AWX REST API.
Version 1 of the Ansible Tower REST API.
Make a GET request to this resource to obtain a list of all child resources
available via the API.

4
awx/api/templates/api/inventory_script_view.md
View File

@@ -10,7 +10,7 @@ object containing groups, including the hosts, children and variables for each
group. The response data is equivalent to that returned by passing the
`--list` argument to an inventory script.
_(New in AWX 1.3)_ Specify a query string of `?hostvars=1` to retrieve the JSON
_(New since AWX 1.3)_ Specify a query string of `?hostvars=1` to retrieve the JSON
object above including all host variables. The `['_meta']['hostvars']` object
in the response contains an entry for each host with its variables. This
response format can be used with Ansible 1.3 and later to avoid making a
@@ -18,7 +18,7 @@ separate API request for each host. Refer to
[Tuning the External Inventory Script](http://www.ansibleworks.com/docs/api.html#tuning-the-external-inventory-script)
for more information on this feature.
_(New in AWX 1.4)_ By default, the inventory script will only return hosts that
_(New since AWX 1.4)_ By default, the inventory script will only return hosts that
are enabled in the inventory. This feature allows disabled hosts to be skipped
when running jobs without removing them from the inventory. Specify a query
string of `?all=1` to return all hosts, including disabled ones.

2
awx/api/views.py
View File

@@ -59,7 +59,7 @@ class ApiRootView(APIView):
current = reverse('api:api_v1_root_view', args=[])
data = dict(
description = 'AWX REST API',
description = 'Ansible Tower REST API',
current_version = current,
available_versions = dict(
v1 = current