plone / plone/plone.restapi

Querystring vocabulary ordering is not retained by REST API response

Open
#1,854 6 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

The sort_keys=True argument used for the response of all REST API calls means that any ordering which was present in the vocabulary is lost.

https://github.com/plone/plone.restapi/blob/7214df34f0c04b621004b79d12691c94761f0160/src/plone/restapi/services/__init__.py#L17-L24

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 at src/plone/restapi/services/init.py lines 17-24 and inspect how sort_keys=True affects REST API responses. Reproduce the response for a vocabulary with a deliberate querystring ordering, then verify that the returned vocabulary preserves that ordering.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.