diff --git a/awx/api/templates/api/_list_common.md b/awx/api/templates/api/_list_common.md index bb9780ee09..ef92b7fc65 100644 --- a/awx/api/templates/api/_list_common.md +++ b/awx/api/templates/api/_list_common.md @@ -54,8 +54,6 @@ within all designated text fields of a model. ?search=findme -_Added in AWX 1.4_ - (_Added in Ansible Tower 3.1.0_) Search across related fields: ?related__search=findme @@ -84,7 +82,7 @@ To exclude results matching certain criteria, prefix the field parameter with ?not__field=value -(_Added in AWX 1.4_) By default, all query string filters are AND'ed together, so +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__`: diff --git a/awx/api/templates/api/inventory_script_view.md b/awx/api/templates/api/inventory_script_view.md index 54c4c7d98b..07656c1eff 100644 --- a/awx/api/templates/api/inventory_script_view.md +++ b/awx/api/templates/api/inventory_script_view.md @@ -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. -_(Added in AWX 1.3)_ Specify a query string of `?hostvars=1` to retrieve the JSON +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,12 +18,12 @@ separate API request for each host. Refer to [Tuning the External Inventory Script](http://docs.ansible.com/developing_inventory.html#tuning-the-external-inventory-script) for more information on this feature. -_(Added in AWX 1.4)_ By default, the inventory script will only return hosts that +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. -_(Added in Tower 3.2.3)_ Specify a query string of `?towervars=1` to add variables +Specify a query string of `?towervars=1` to add variables to the hostvars of each host that specifies its enabled state and database ID. To apply multiple query strings, join them with the `&` character, like `?hostvars=1&all=1`.