Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add querystring_search get method #1616

Merged
merged 10 commits into from
Apr 6, 2023
Merged

Add querystring_search get method #1616

merged 10 commits into from
Apr 6, 2023

Conversation

robgietema
Copy link
Member

See #1252 for details

@mister-roboto
Copy link

@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
Copy link

netlify bot commented Apr 4, 2023

Deploy Preview for plone-restapi ready!

Name Link
🔨 Latest commit 6b3cefd
🔍 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.

Copy link
Member

@sneridagh sneridagh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sneridagh sneridagh requested a review from davisagli April 5, 2023 08:20
@sneridagh
Copy link
Member

@jenkins-plone-org please run jobs

@sneridagh
Copy link
Member

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

@robgietema
Copy link
Member Author

@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.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor tweaks to the docs.

docs/source/endpoints/querystringsearch.md Outdated Show resolved Hide resolved
docs/source/endpoints/querystringsearch.md Outdated Show resolved Hide resolved
docs/source/endpoints/querystringsearch.md Outdated Show resolved Hide resolved
Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, aside from the doc tweaks that Steve requested

tisto and others added 3 commits April 6, 2023 08:36
Co-authored-by: Steve Piercy <web@stevepiercy.com>
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@tisto
Copy link
Member

tisto commented Apr 6, 2023

@jenkins-plone-org please run jobs

@tisto
Copy link
Member

tisto commented Apr 6, 2023

@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 (plone/volto#4658) already has been merged. I am around to making a release anytime today.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@robgietema robgietema merged commit c274e22 into master Apr 6, 2023
@robgietema robgietema deleted the querystring-search-get branch April 6, 2023 08:09
@stevepiercy
Copy link
Contributor

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"?

tisto added a commit that referenced this pull request Apr 7, 2023
davisagli added a commit that referenced this pull request Apr 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants