plone / plone/plone.app.querystring
vocabulary entries returned do not include their token
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 25
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 2
Description
When a vocabulary is used by a querystring param only value and title are returned. This also exposes the values via the REST api which can become problematic, as values are not necessarily string values, but can potentially even be python objects.
Therefore we should aim to rather use the token instead of value when used in Volto via REST api. To prepare for that change, the token should be included in the api response. In a later stage we should refactor it so, that the api response does not include the value at all. But that should be done in plone.restapi and volto respectively.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the code and tests that build vocabulary entries for querystring parameters in the REST response. Confirm how value and title are currently returned, then make the token available as well and update the relevant tests; leave the later removal of value to plone.restapi and Volto.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100