Project

Profile

Help

Issue #3635

closed

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

Added by amacdona@redhat.com over 4 years ago. Updated almost 3 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
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 #1

Updated by dalley over 4 years ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 36
Actions #2

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 36 to Sprint 37
Actions #3

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 37 to Sprint 38
Actions #4

Updated by jortel@redhat.com over 4 years ago

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

Updated by jortel@redhat.com over 4 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.

Actions #6

Updated by amacdona@redhat.com over 4 years ago

  • Description updated (diff)
Actions #7

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 38 to Sprint 39
Actions #8

Updated by daviddavis over 4 years ago

  • Tags Documentation added
Actions #9

Updated by daviddavis over 4 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to daviddavis
Actions #10

Updated by daviddavis over 4 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.

Actions #11

Updated by daviddavis over 4 years ago

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

Updated by daviddavis over 4 years ago

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

Updated by daviddavis over 4 years ago

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

Updated by daviddavis over 4 years ago

  • Status changed from ASSIGNED to POST
Actions #15

Updated by dkliban@redhat.com over 4 years ago

  • Sprint changed from Sprint 39 to Sprint 40

Added by daviddavis over 4 years ago

Revision d0aa104d

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

Added by daviddavis over 4 years ago

Revision d0aa104d

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

Actions #16

Updated by daviddavis over 4 years ago

  • Status changed from POST to MODIFIED
Actions #17

Updated by amacdona@redhat.com about 4 years ago

  • Has duplicate Story #2335: As an API consumer, I am able to discover filterable fields. added
Actions #18

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #19

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3)
Actions #20

Updated by bmbouter almost 3 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF