plone / plone.restapi

RESTful API for Plone.
http://plonerestapi.readthedocs.org/
90 stars 79 forks source link

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

Open Faakhir30 opened 2 months ago

Faakhir30 commented 2 months ago

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.

Spinachboul commented 1 week ago

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

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

Spinachboul commented 1 week ago

@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 commented 1 week ago

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