plone / plone/plone.restapi

Query params checking often do not allow for negated values

Open
#437 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
109
Forks
107
Avg merge
2d 3h
Merged PRs (30d)
4

Description

For example /@search?fullobjects=0 doesn't work as we currently on check for the existence of the key.

A better pattern would be:

param = bool(query.pop('param_name', False))
if param:
    # do stuff

We'd like to support something like:
?fullobjects -> True
?fullobjects=1 -> True
?fullobjects=true -> True
?fullobjects=0 -> false
?fullobjects=false -> True

See https://github.com/plone/plone.restapi/commit/0cbbbd6f2982bd5825aa65b69e29b9f085dc4a34#diff-4b712dc75a1e6e0c15905d04775f5903R48

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the query-parameter handling described in the issue and the code shown in the referenced commit. Trace how presence-only parameters and values such as 0, 1, true, and false are interpreted, then add or update coverage for the requested behavior and verify the REST API tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.