Merge pull request #3856 from NateWr/i8844_api_docs

pkp/pkp-lib#8844 Update API docs for 3.4
pkp · Mar 29, 2023 · 9a606e6 · 9a606e6
2 parents e3b451e + 7bd9c63
commit 9a606e6
Show file tree

Hide file tree

Showing 53 changed files with 2,335 additions and 522 deletions.
diff --git a/api/v1/_dois/BackendDoiHandler.php b/api/v1/_dois/BackendDoiHandler.php
@@ -129,7 +129,7 @@ public function editIssue(SlimRequest $slimRequest, APIResponse $response, array
             $context,
             $this->getUserGroups($context->getId()),
             $this->getGenres($context->getId())
-        ));
+        ), 200);
     }
 
     protected function getUserGroups(int $contextId): LazyCollection

diff --git a/api/v1/dois/DoiHandler.php b/api/v1/dois/DoiHandler.php
@@ -327,7 +327,7 @@ public function assignIssueDois(SlimRequest $slimRequest, APIResponse $response,
         $context = $this->getRequest()->getContext();
         $doiPrefix = $context->getData(Context::SETTING_DOI_PREFIX);
         if (empty($doiPrefix)) {
-            return $response->withStatus(400)->withJsonError('api.dois.400.prefixRequired');
+            return $response->withStatus(403)->withJsonError('api.dois.403.prefixRequired');
         }
 
         $failedDoiActions = [];

diff --git a/docs/dev/swagger-source-decision-examples.json b/docs/dev/swagger-source-decision-examples.json
@@ -0,0 +1,203 @@
+{
+    "APP\\decision\\types\\Accept": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "email",
+                "id": "notifyReviewers",
+                "canChangeRecipients": true
+            },
+            {
+                "type": "form",
+                "id": "payment",
+                "data": {
+                    "requestPayment": true
+                }
+            }
+        ]
+    },
+    "PKP\\decision\\types\\BackFromCopyediting": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\BackFromProduction": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\CancelReviewRound": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "email",
+                "id": "notifyReviewers",
+                "canChangeRecipients": true
+            }
+        ]
+    },
+    "PKP\\decision\\types\\Decline": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "email",
+                "id": "notifyReviewers",
+                "canChangeRecipients": true
+            }
+        ]
+    },
+    "PKP\\decision\\types\\InitialDecline": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\NewExternalReviewRound": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RecommendAccept": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "discussion",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RecommendDecline": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "discussion",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RecommendResubmit": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "discussion",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RecommendRevisions": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "discussion",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RequestRevisions": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "email",
+                "id": "notifyReviewers",
+                "canChangeRecipients": true
+            }
+        ]
+    },
+    "PKP\\decision\\types\\Resubmit": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "email",
+                "id": "notifyReviewers",
+                "canChangeRecipients": true
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RevertDecline": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\RevertInitialDecline": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\SendExternalReview": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "PKP\\decision\\types\\SendToProduction": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            }
+        ]
+    },
+    "APP\\decision\\types\\SkipExternalReview": {
+        "actions": [
+            {
+                "type": "email",
+                "id": "notifyAuthors",
+                "canChangeRecipients": false
+            },
+            {
+                "type": "form",
+                "id": "payment",
+                "data": {
+                    "requestPayment": true
+                }
+            }
+        ]
+    }
+}