Enable global Control Panel search via plone.restapi searchable text - 1981#1982
Enable global Control Panel search via plone.restapi searchable text - 1981#1982Manik-Khajuria-5 wants to merge 6 commits intoplone:mainfrom
Conversation
|
@Manik-Khajuria-5 thanks for creating this Pull Request and helping to improve Plone! TL;DR: Finish pushing changes, pass all other checks, then paste a comment: To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically. Happy hacking! |
|
@jenkins-plone-org please run jobs |
|
@stevepiercy can u help why docs test is failig I have included it |
|
@davisagli I’ve opened a PR that adds a backend endpoint returning aggregated searchable text for Control Panel settings, following the discussion in the Volto issue |
|
@Manik-Khajuria-5 sorry, I have no idea. What did you try? What do the error messages say and advise you to do? It's a good idea to run the tests locally and follow the guidelines from https://6.docs.plone.org/plone.restapi/docs/source/contributing/index.html. |
|
okay will try to improve locally it was working fine |
|
I think some of the CI failures were due to a github incident in progress. So let's see what happens next time you update the PR. |
|
@davisagli Thanks for review I will update PR shortly as per changes recomended |
|
@davisagli Implemented the changes successfully Should I work on frontend issue now for searchable text? |
davisagli
left a comment
There was a problem hiding this comment.
The failure on the "uncommitted doc changes" build is because this changes the expected response for the controlpanel service. You have to run the tests locally, and commit the changes, so that they can be included in the docs.
news/1981.bugfix.rst
Outdated
| @@ -0,0 +1 @@ | |||
| Added a single Control Panel API endpoint exposing searchable text for global settings search. Fixes #1981. No newline at end of file | |||
There was a problem hiding this comment.
The issue will be automatically linked based on the filename.
Add attribution for yourself:
| Added a single Control Panel API endpoint exposing searchable text for global settings search. Fixes #1981. | |
| Added a single Control Panel API endpoint exposing searchable text for global settings search. @Manik-Khajuria-5 |
And finally, the changelog for this package is in Markdown. So this file needs to be renamed to 1981.bugfix instead of 1981.bugfix.rst
| """Remove controlpanel children by names""" | ||
|
|
||
| def get_searchable_text(): | ||
| """Return searchable text for this controlpannel. |
There was a problem hiding this comment.
| """Return searchable text for this controlpannel. | |
| """Return searchable text for this control panel. |
|
@davisagli I will make make these changes as soon as possible |
Co-authored-by: David Glick <david@glicksoftware.com>
|
@davisagli I have implemented the changes u suggested, previously this test was not failing but now it failed Can u please review this |
Fixes #1981:
Summary
This PR adds a single Control Panel REST API endpoint that exposes aggregated searchable text for all control panel settings.
The endpoint returns panel titles,as searchable text, enabling efficient global Control Panel search without fetching individual schemas on the frontend.
References
Closes #1981