improve GET submissions/{submissionId}/decisions endpoint

pkp / pkp-lib

The library used by PKP's applications OJS, OMP and OPS, open source software for scholarly publishing.

https://pkp.sfu.ca

GNU General Public License v3.0

307 stars 447 forks source link

improve GET submissions/{submissionId}/decisions endpoint #10465

Closed jardakotesovec closed 1 month ago

jardakotesovec commented 2 months ago

Describe the issue While triaging https://github.com/pkp/pkp-lib/issues/10360, I came to conclusion, that for listing actual recommendations from recommend only editors, we could use the /decision endpoint. But there is couple of things that would make it nice to work with.

Useful additions would be:

add query param to being able to filter by decision type (multiple values), to get only decisions I am interested in
add query param to being able to filter by the editorId, if I am for example interested only in my decisions I could use that. Ideally to support also multiple editorIds
add query param to being able to filter by reviewRoundId
add query param to being able to filter by stageId
sorting by the dateDecision - for me most useful would be to sort it so the first are the newest decisions.

What application are you using? OJS, OMP or OPS version 3.5

ewhanson commented 2 months ago

Hey @taslangraham, could you have a look at adding the queries params under useful additions above? The filters decision type and editor ID already exist and one would need to be added for the dateDecision in addition to the changes in the API call. Let me know if you have any questions!

jardakotesovec commented 2 months ago

@ewhanson Oh great, I was looking to https://docs.pkp.sfu.ca/dev/api/ojs/3.4#tag/Submissions-Decisions and did not check in source code if there are query params available. Would be possible to also add existing query params to the docs?

jardakotesovec commented 2 months ago

Added also filtering by reviewRoundId and stageId to the issue description, but these are less important if that would be hassle.

taslangraham commented 2 months ago

Will take a look

ewhanson commented 2 months ago

Hey @jardakotesovec, the filters I mentioned are in the collector but not currently accessible through the API endpoints, though that should make adding them to the API pretty straightforward.

taslangraham commented 2 months ago

Ready for review @ewhanson

pkp-lib: https://github.com/pkp/pkp-lib/pull/10469/files
ojs: https://github.com/pkp/ojs/pull/4447/files
omp: https://github.com/pkp/omp/pull/1707/files (submodule update)
ops: https://github.com/pkp/ops/pull/777/files (submodule update)

ewhanson commented 1 month ago

Thanks @taslangraham. Just one minor issue in a doc comment. Feel free to merge after updating it.

taslangraham commented 1 month ago

All merged! Thanks for te review @ewhanson