search

plone / plone.restapi

RESTful API for Plone.
http://plonerestapi.readthedocs.org/
84 stars 73 forks source link

Add querystring_search get method #1616

Closed robgietema closed 1 year ago

robgietema commented 1 year ago

See #1252 for details

mister-roboto commented 1 year ago

@robgietema thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

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!

netlify[bot] commented 1 year ago

Deploy Preview for plone-restapi ready!

Name Link
Latest commit 6b3cefd162ca76631c0d6077fb6ea48eda9f16cb
Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/642e6a7f1ed6670008ca9ab2
Deploy Preview https://deploy-preview-1616--plone-restapi.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

sneridagh commented 1 year ago

@jenkins-plone-org please run jobs

sneridagh commented 1 year ago

@robgietema Now that I realise, I think the only thing missing is a bit on documentation.

robgietema commented 1 year ago

@robgietema Now that I realise, I think the only thing missing is a bit on documentation.

Agreed, I did add them but it seems it got lost while merging. I've added the docs again.

tisto commented 1 year ago

@jenkins-plone-org please run jobs

tisto commented 1 year ago

@robgietema LGTM! Awesome that we can just add this feature without the need for a new major version. :)

When reading the docs, I was wondering if we could be more explicit about how URL encoding works. We could either add one or two lines on how to do the conversion (e.g. in JavaScript) works or link to existing documentation (risky because it could break in the future):

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI?retiredLocale=de

What do you think? @stevepiercy opinions regarding external links vs inline docs?

I saw that the Volto part (https://github.com/plone/volto/pull/4658) already has been merged. I am around to making a release anytime today.

stevepiercy commented 1 year ago

Whoops, I just saw your comment @tisto after approving the docs.

I agree with your idea. An entry in the Glossary would be preferred, using a standard definition, JavaScript method to do the encoding, and a link to MDN for details and demos. Keeps the main docs clean, while providing a reference that we can use here and other parts of the docs.

I also noticed that we use "URL-encoded", but should it be "URI-encoded"?