Project

Profile

Help

Issue #3635

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

Added by amacdona@redhat.com over 1 year ago. Updated 7 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 40

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 dates MODIFIED Actions
Related to Pulp - Issue #3826: Range filter help text should specify the format allowed MODIFIED Actions
Related to File Support - Issue #3827: Filters on content list lack help text MODIFIED Actions
Duplicated by Pulp - Story #2335: As an API consumer, I am able to discover filterable fields. CLOSED - DUPLICATE Actions

Associated revisions

Revision d0aa104d View on GitHub
Added by daviddavis over 1 year ago

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

Revision d0aa104d View on GitHub
Added by daviddavis over 1 year ago

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

Revision d0aa104d View on GitHub
Added by daviddavis over 1 year ago

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

History

#1 Updated by dalley over 1 year ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 36

#2 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 36 to Sprint 37

#3 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 37 to Sprint 38

#4 Updated by jortel@redhat.com over 1 year ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to jortel@redhat.com

#5 Updated by jortel@redhat.com over 1 year 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.

#6 Updated by amacdona@redhat.com over 1 year ago

  • Description updated (diff)

#7 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 38 to Sprint 39

#8 Updated by daviddavis over 1 year ago

  • Tags Documentation added

#9 Updated by daviddavis over 1 year ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to daviddavis

#10 Updated by daviddavis over 1 year 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.

#11 Updated by daviddavis over 1 year ago

  • Related to Issue #3825: Date filter help text should specify the format of the dates added

#12 Updated by daviddavis over 1 year ago

  • Related to Issue #3826: Range filter help text should specify the format allowed added

#13 Updated by daviddavis over 1 year ago

  • Related to Issue #3827: Filters on content list lack help text added

#14 Updated by daviddavis over 1 year ago

  • Status changed from ASSIGNED to POST

#15 Updated by dkliban@redhat.com over 1 year ago

  • Sprint changed from Sprint 39 to Sprint 40

#16 Updated by daviddavis over 1 year ago

  • Status changed from POST to MODIFIED

#17 Updated by amacdona@redhat.com about 1 year ago

  • Duplicated by Story #2335: As an API consumer, I am able to discover filterable fields. added

#18 Updated by daviddavis 7 months ago

  • Sprint/Milestone set to 3.0

#19 Updated by bmbouter 7 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF