[Meta] Submission listing: api dependencies

[jardakotesovec]

Meta issue just to track various outstanding issues for API adjustments that are required to power new submission
listing.

Bold are priority issues.

Missing data

• reviewMethod, reviewerName on /_submissions endpoint in reviewAssignments array - Enhance submission schema with review assignment data #9965
• as reviewer - I am getting all the reviewAssignments in the /submission/ endpoint. Thats needs to be adjusted to only assigned and open ones - Enhance submission schema with review assignment data #9965
• statusId & publication locale on _submissions/reviewerAssignments - Fetch submission' title for the reviewer assignments list #9825
• expose publication form via API - Expose publication forms via API #10336
• Add stage assignment metadata to /participants - Additional data for submissions/{ID}/participants API #10280 @ewhanson
• Exposing metadataLocale in submission - Include metadataLocales in /submissions/{submissionId} API #10329 @bozana
• Additional fields in submission schema - Additional fields in Submission schema in API for 3.5 #10480 @Vitaliy-1
• Expose emailEntry API - API for emailLogEntry #10412
• Improve decision API - improve GET submissions/{submissionId}/decisions endpoint #10465
• reviewAssignments that are cancelled/declined are filtered out - Submissions schema filters out declined&cancelled review assignments #10076 @Vitaliy-1
• add REVIEW_ASSIGNMENT_STATUS_VIEWED status - Mark review assignment when it's opened by an editor #9799 @Vitaliy-1
• review assignment date of confirmation - Exposing date when editor confirmed review in API #10359
• LoginAs & Gossip for reviewers and Login as for Paritcipants - Detect on the frontend whether current user can "log in as" reviewer/participant #10290
• API for retrieving files uploaded by reviewer (will be needed bit later, so low priority now) - API for retrieving files uploaded by reviewer #9963
• API for retrieving submission files with Reviewer role (will be needed bit later, so low priority now) - API for retrieving submission files with Reviewer role #9964

Views adjustments

• New Review Assignment listing: reviewer-assignments-all view returns also published submissions New Review Assignment listing: reviewer-assignments-all view returns also published submissions #10009
• New submission listing: assigned-to-me View should include authors? New submission listing: assigned-to-me View should include authors? #10010

Other submission listing backend Improvements

• Set dates when resending request - Permit declined reviews to be reinitiated #4789
• Editorial activity additional information REST API should return more information about submission editorial activity #8885
• Removing Cancel Review Assignment Remove the option of "Cancel Review Assignment" after the Review has been declined #9948

These might not be necessary anymore as design evolved, but will keep them around in case we still decide to show some specific metadata on the new side modal workflow page

• Submission Summary metadata - Type - sections - issue to be created
• Submission Summary metadata - Submission language - issue to be created
• Submission Summary metadata - days in "stage" - issue to be created
• Latest activity log - issue to be created
• journal name - issue to be created

[Vitaliy-1]

@jardakotesovec, can you describe in more details this one:

as reviewer - I am getting all the reviewAssignments in the /submission/ endpoint. Thats needs to be adjusted to only assigned and open ones - #9965

I'm unable to reproduce the problem. I'm calling ...publicknowledge/api/v1/submissions as a reviewer and don't retrieve any reviews. Response example:

{
    "itemsMax": 8,
    "items": [
        {
            "_href": "http://localhost:8000/index.php/publicknowledge/api/v1/submissions/19",
            "contextId": 1,
            "currentPublicationId": 20,
            "dateLastActivity": "2024-06-06 05:35:00",
            "dateSubmitted": "2024-06-06 05:34:30",
            "editorAssigned": true,
            "id": 19,
            "lastModified": "2024-06-06 05:34:30",
            "locale": "en",
            "publications": [
                {
                    "_href": "http://localhost:8000/index.php/publicknowledge/api/v1/submissions/19/publications/20",
                    "authorsString": "",
                    "authorsStringIncludeInBrowse": "",
                    "authorsStringShort": "",
                    "categoryIds": [],
                    "coverImage": {
                        "en": null,
                        "fr_CA": null
                    },
                    "datePublished": null,
                    "doiObject": null,
                    "fullTitle": {
                        "en": "Finocchiaro: Arguments About Arguments",
                        "fr_CA": ""
                    },
                    "galleys": [],
                    "id": 20,
                    "locale": "en",
                    "pages": null,
                    "prefix": {
                        "en": "",
                        "fr_CA": ""
                    },
                    "primaryContactId": 28,
                    "pub-id::publisher-id": null,
                    "sectionId": 2,
                    "status": 1,
                    "submissionId": 19,
                    "subtitle": {
                        "en": "",
                        "fr_CA": ""
                    },
                    "title": {
                        "en": "Finocchiaro: Arguments About Arguments",
                        "fr_CA": ""
                    },
                    "urlPublished": "http://localhost:8000/index.php/publicknowledge/en/article/view/19/version/20",
                    "version": 1
                }
            ],
            "recommendationsIn": null,
            "reviewersNotAssigned": true,
            "revisionsRequested": false,
            "revisionsSubmitted": false,
            "scheduledIn": null,
            "stageId": 4,
            "status": 1,
            "statusLabel": "Queued",
            "submissionProgress": "",
            "urlAuthorWorkflow": "http://localhost:8000/index.php/publicknowledge/en/authorDashboard/submission/19",
            "urlEditorialWorkflow": "http://localhost:8000/index.php/publicknowledge/en/workflow/access/19",
            "urlPublished": "http://localhost:8000/index.php/publicknowledge/en/article/view/19",
            "urlSubmissionWizard": "http://localhost:8000/index.php/publicknowledge/en/submission?id=19",
            "urlWorkflow": "http://localhost:8000/index.php/publicknowledge/en/reviewer/submission/19"
        },
        ...
    ]
}

[jardakotesovec]

@Vitaliy-1 I meant endpoint for specific submission - index.php/publicknowledge/api/v1/submissions/12

[Vitaliy-1]

Author and reviewers have access to that endpoint, which includes information about reviews. If the review isn't open, the reviewer name is anonymised (the same for the author name for double-blind reviews). Do you think the rest of data about the review is also sensitive?

[Vitaliy-1]

example of data:

{
      "id": 27,
      "isCurrentUserAssigned": false,
      "statusId": 0,
      "status": "Waiting for a response from the reviewer.",
      "dateDue": "2024-07-04",
      "dateResponseDue": "2024-07-04",
      "dateConfirmed": null,
      "dateCompleted": null,
      "dateAssigned": "2024-06-06",
      "round": 1,
      "roundId": 13,
      "recommendation": null,
      "dateCancelled": null,
      "reviewerFullName": "",
      "reviewMethod": 2
  }

[jardakotesovec]

@Vitaliy-1 Alright, not sure whether someone would find these sensitive.