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
297 stars 442 forks source link

Evaluate what information to expose to the author and reviewers regarding submission #9956

Open Vitaliy-1 opened 3 months ago

Vitaliy-1 commented 3 months ago

Consider what submission schema data should be exposed to the author, i.e., through the API the data can be received with .../submissions/{submissionId} endpoint.

Review assignments data that is already available: id, isCurrentUserAssigned, statusId, status, due, responseDue, round, roundId. The work on submission lists adds: dateConfirmed, dateCompleted, dateAssigned, recommendation, dateCancelled.

The new data also includes: recommendationsIn, reviewersNotAssigned, revisionsRequested, revisionsSubmitted, scheduledIn.

jardakotesovec commented 3 months ago

@Vitaliy-1 Just to summarise what @Devika008 is proposing to display to authors.

Screenshot 2024-05-14 at 16 02 56

If we would want to include just the minimal info (counts, and open reviewers names) that would be fine. If we share full reviewAssignments with statusId - thats fine as well - its easy to calculate the counts client side. Obviously we need to include names only for the open reviews situation.

Not sure whether sharing any other fields would be problematic. Also whether sharing declined/cancelled review assignment might not be desirable?

Would need these both for _submission and /submission/{submissionId}/

Vitaliy-1 commented 3 months ago

Thanks!

When the reviews are open, she would like to also displays reviewer name & initials for these. We can put Initials aside, we will figure out where to calculate them in separate issue. But basically need reviewMethod and reviewer name.

Working on this here: https://github.com/pkp/pkp-lib/issues/9965

Basically speaking, all information from a submission schema is exposed to authors and reviewers through the API. I'll anonymize critical data and leave general info but we need also to compare it to different journals' workflow.