Issue #3635
closed
Improve filter documentation by creating a BaseFilterSet class to automatically set filter help text
Description
The filters are not as well documented as other parameters.
It would be really nice to add help text to each of the filters, particularly the filters that are tricky to get right like the created__gte.
Related issues
Updated by dalley over 6 years ago
- Triaged changed from No to Yes
- Sprint set to Sprint 36
Updated by jortel@redhat.com over 6 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to jortel@redhat.com
Updated by jortel@redhat.com over 6 years ago
- Status changed from ASSIGNED to NEW
- Assignee deleted (
jortel@redhat.com)
This does not appear to be supported by django. At least not in the documented API.
Updated by daviddavis over 6 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to daviddavis
Updated by daviddavis over 6 years ago
- Subject changed from Improve filter documentation to Improve filter documentation by creating a BaseFilterSet class to automatically set filter help text
I'm reducing the scope of this bug to simply create a BaseFilterSet class to automatically set filter help text. Will open some other issues around ways the filter text could be improved.
Updated by daviddavis over 6 years ago
- Related to Issue #3825: Date filter help text should specify the format of the dates added
Updated by daviddavis over 6 years ago
- Related to Issue #3826: Range filter help text should specify the format allowed added
Updated by daviddavis over 6 years ago
- Related to Issue #3827: Filters on content list lack help text added
Updated by daviddavis over 6 years ago
- Status changed from ASSIGNED to POST
Updated by dkliban@redhat.com over 6 years ago
- Sprint changed from Sprint 39 to Sprint 40
Added by daviddavis over 6 years ago
Added by daviddavis over 6 years ago
Revision d0aa104d | View on GitHub
Automatically set help text in schema for filters
Creating a BaseFilterSet class that will automatically set help_text for filters in our REST API schema.
Updated by daviddavis over 6 years ago
- Status changed from POST to MODIFIED
Applied in changeset pulp|d0aa104d581d4a32a3010f2f8cdc2377aca5e0ed.
Updated by amacdona@redhat.com almost 6 years ago
- Has duplicate Story #2335: As an API consumer, I am able to discover filterable fields. added
Updated by bmbouter almost 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
.
Automatically set help text in schema for filters
Creating a BaseFilterSet class that will automatically set help_text for filters in our REST API schema.
fixes #3635 https://pulp.plan.io/issues/3635