plone / plone/plone.restapi

Use new navigation code in Plone 5.2+

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

Nobody has claimed this yet.

04 type: enhancement 13 prio: normal
Dominant language
Python
Stars
109
Forks
107
Avg merge
2d 3h
Merged PRs (30d)
4

Description

The @navigation endpoint
https://github.com/plone/plone.restapi/blob/master/src/plone/restapi/services/navigation/get.py
uses the old (slow) navigation code (as in Plone 4.2-5.1).

If using Plone 5.2+ the faster new style code should be used. See in https://github.com/plone/plone.app.layout/blob/5f597e41c413c1584a25f01347ead48da52d77c4/plone/app/layout/viewlets/common.py#L276 for its implementation.

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 in src/plone/restapi/services/navigation/get.py and compare its navigation handling with the implementation linked in plone/app/layout/viewlets/common.py around line 276. Confirm how the newer implementation is selected for Plone 5.2+ while preserving compatibility with earlier versions. Done means the @navigation endpoint uses the faster navigation code on supported Plone versions.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.