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 support of filters to download aliases in CSV format. #1819

Open
Faakhir30 opened this issue Sep 27, 2024 · 3 comments
Open

Add support of filters to download aliases in CSV format. #1819

Faakhir30 opened this issue Sep 27, 2024 · 3 comments

Comments

@Faakhir30
Copy link
Contributor

The RedirectsControlPanel already supports filters like start, end, datetime, etc when using Allias Service to get using JSON, however, we've added the capability to download and upload aliases in bulk using CSV, refer to #1813 PR.

It would be nice to have these filters applied when using CSV format.
This would probably require to update download functionality at Products.CMFPlone

Also, it requires updates at Allias Get service in plone.restapi, respective docs, and tests.

@plone plone deleted a comment Nov 8, 2024
@plone plone deleted a comment from TheVinaySagar Nov 9, 2024
@plone plone deleted a comment from Spinachboul Nov 22, 2024
@plone plone deleted a comment from Faakhir30 Nov 22, 2024
@Spinachboul
Copy link

Spinachboul commented Nov 23, 2024

@Faakhir30
I have started working on the issue and would shortly submit a PR draft for the same.
Plan of action

  • Update the download functionality to include the filter parameters and ensure they are applied during csv generation
  • Ensure consistancy with the json alias
  • Update the alias retrieval in plone.restapi to handle the csv filters
  • update the documentation to describe the new behaviour of the csv
  • write new tests to validate the filtered csv functionality and ensure its compatibility

I welcome any feedback or any kind of improvement with respect to the implementation.
Thanks!!

@Spinachboul
Copy link

@Faakhir30
Could you please tell me how to perform tests and make docs for the changes I made in the CMFPlone
and also the get.py in the plone.restAPI
I went through the https-examples but not able to figure out how I can simulate similar tests.
Thanks!!

@stevepiercy
Copy link
Contributor

@Spinachboul every Plone project has a contributing guide, usually found by visiting the repository root and reading its contributing.md or readme.md or similarly named files. Plone REST API is one of the few projects that publishes its contributing guide in the main Plone documentation, which is located at https://6.docs.plone.org/plone.restapi/docs/source/contributing/index.html.

If that guide does not help you get started, then please create a new issue in this repo, including what is not clear, and the exact steps to reproduce what you did and observed.

Good luck!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants