Project

Profile

Help

Actions
Send by e-mail Copy link

Issue #1575

closed

search criteria docs imply pulp is more strict than it really is

Added by semyers over 8 years ago. Updated almost 4 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Low
Assignee:
semyers
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Estimated time:
Severity:
1. Low
Version:
Platform Release:
2.8.0
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix, Pulp 2
Sprint:
Quarter:

Description

https://pulp.readthedocs.org/en/latest/dev-guide/conventions/criteria.html#search-criteria says:

Any API that supports this criteria will accept a JSON document with a criteria field. The criteria field will be a sub-document with the following fields:

filters
sort
limit
skip
fields

I interpret "will" in this context to be of the same imperative strength as "MUST/SHALL"[0], where in our actual implementation those fields merely "MAY" appear in the search criteria.

[0]: https://www.ietf.org/rfc/rfc2119.txt

Actions
Send by e-mail Copy link

Also available in: Atom PDF