From ceda0de4149293fb1887f74c774768d2cd6415b3 Mon Sep 17 00:00:00 2001
From: Andrei Cioromila <andrei.cioromila@thinslices.com>
Date: Fri, 26 Oct 2018 13:51:46 +0300
Subject: [PATCH] docs(collections): update docs for delete endpoint
---
.../src/Collections.js | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/packages/component-manuscript-manager/src/Collections.js b/packages/component-manuscript-manager/src/Collections.js
index 178ca4dbc..81f8c4d7f 100644
--- a/packages/component-manuscript-manager/src/Collections.js
+++ b/packages/component-manuscript-manager/src/Collections.js
@@ -7,8 +7,8 @@ const Collections = app => {
session: false,
})
/**
- * @api {get} /api/fragments Get latest fragments
- * @apiGroup Fragments
+ * @api {get} /api/collections Get latest collections
+ * @apiGroup Collections
* @apiSuccessExample {json} Success
* HTTP/1.1 200 OK
* [
@@ -28,7 +28,7 @@ const Collections = app => {
* }
* }
* ]
- * @apiErrorExample {json} Get fragments errors
+ * @apiErrorExample {json} Get collections errors
* HTTP/1.1 403 Forbidden
*/
app.get(
@@ -37,6 +37,14 @@ const Collections = app => {
require(`${routePath}/get`)(app.locals.models),
)
+ /**
+ * @api {delete} /api/collections/:collectionId Delete collection with specified id
+ * @apiGroup Collections
+ * @apiSuccessExample {json} Success
+ * HTTP/1.1 204 Accepted
+ * @apiErrorExample {json} Get collections errors
+ * HTTP/1.1 403 Forbidden
+ */
app.delete(
'/api/collections/:collectionId',
authBearer,
--
GitLab