Project

Profile

Help

Actions
Send by e-mail Copy link

Issue #3635

closed

Improve filter documentation by creating a BaseFilterSet class to automatically set filter help text

Added by amacdona@redhat.com over 6 years ago. Updated almost 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
daviddavis
Category:
-
Sprint/Milestone:
3.0.0
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 40
Quarter:

Description

The filters are not as well documented as other parameters.

Example:
https://docs.pulpproject.org/en/3.0/nightly/integration-guide/rest-api/index.html#get--repositories-repository_pk-versions-

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

Related to Pulp - Issue #3825: Date filter help text should specify the format of the datesCLOSED - CURRENTRELEASEvdusekActions
Related to Pulp - Issue #3826: Range filter help text should specify the format allowedCLOSED - CURRENTRELEASEvdusekActions
Related to File Support - Issue #3827: Filters on content list lack help textCLOSED - CURRENTRELEASEvdusekActions
Has duplicate Pulp - Story #2335: As an API consumer, I am able to discover filterable fields.CLOSED - DUPLICATE

Actions
Actions
Send by e-mail Copy link

Also available in: Atom PDF