diff options
| author | TVo <thavo@redhat.com> | 2024-07-09 18:55:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-09 18:55:19 +0200 |
| commit | 4e055f46c4a8a915411bbeee85cd73d745b97005 (patch) | |
| tree | 6e9af5a0b4f419d586e5c36ec6061e89cacf575b /docs | |
| parent | Callback for role assignment (#15339) (diff) | |
| download | awx-4e055f46c4a8a915411bbeee85cd73d745b97005.tar.xz awx-4e055f46c4a8a915411bbeee85cd73d745b97005.zip | |
Added note to API guide for filtering exact matches (#15332)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docsite/rst/rest_api/filtering.rst | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/docsite/rst/rest_api/filtering.rst b/docs/docsite/rst/rest_api/filtering.rst index 680adcd58b..1357095d47 100644 --- a/docs/docsite/rst/rest_api/filtering.rst +++ b/docs/docsite/rst/rest_api/filtering.rst @@ -94,7 +94,7 @@ Field lookups may also be used for more advanced queries, by appending the looku The following field lookups are supported: -- ``exact``: Exact match (default lookup if not specified). +- ``exact``: Exact match (default lookup if not specified, refer to the following note for more information). - ``iexact``: Case-insensitive version of exact. - ``contains``: Field contains value. - ``icontains``: Case-insensitive version of contains. @@ -122,3 +122,18 @@ Filtering based on the requesting user's level of access by query string paramet - ``role_level``: Level of role to filter on, such as ``admin_role`` + +.. note:: + + Previous releases of AWX returned queries with **__exact** results by default, but you may find that the latest versions are returning a larger subset instead. As a workaround, set the ``limit`` to ``?limit__exact`` for the default filter. For example, ``/api/v2/jobs/?limit__exact=example.domain.com`` results in: + + :: + + { + "count": 1, + "next": null, + "previous": null, + "results": [ + ... + +.. this note is generically written for AWX. For downstream, the change started in AAP 2.0 so we can be more specific if necessary. |