8000 Improve API filtering docs to clarify that not all fields are filterable · Issue #15971 · ansible/awx · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Improve API filtering docs to clarify that not all fields are filterable #15971
Open
@joecaruso

Description

@joecaruso

It would be helpful to add a bit of ad 50FB ditional information to the API filtering documentation to talk about how not all fields are filterable. The way the docs are written today, it seems to imply that any field is possible to filter on.
The only statement available to indicate this is not the case is "Only fields and relations that exist in the database may be used for filtering. " which is not very friendly to most users in my opinion.

Adding info about how you can send an OPTIONS call to the API to return which fields are filterable would be helpful as well.

Currently when you try to filter on a field that's not filterable, you receive the following error from the API.
Example: Trying to filter on the limit field in the schedules API
{ "detail": "Schedule has no field named 'limit'" }

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0