Project

Profile

Help

Story #2335

closed

As an API consumer, I am able to discover filterable fields.

Added by semyers about 8 years ago. Updated over 5 years ago.

Status:
CLOSED - DUPLICATE
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:
Quarter:

Description

In chatting with asmacdo about his filterset PR for Repository[0], we were lamenting the lack of discoverability of the filter params. We'd love for autogenerated API clients to be able to know what filter options are allowed on a given view, and also to make sure the filter sets associated with a given API view show up meaningfully in the API docs that we generate.

[0]: https://github.com/pulp/pulp/pull/2783


Related issues

Is duplicate of Pulp - Issue #3635: Improve filter documentation by creating a BaseFilterSet class to automatically set filter help textCLOSED - CURRENTRELEASEdaviddavisActions

Also available in: Atom PDF