docs: added copy to docs

rocketbase-io · Jun 24, 2020 · da604df · da604df
1 parent 19bc6ad
commit da604df
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ Containing an implementation for storing asset references...
 | asset.imagemagick.enabled | false      | you can active imagemagick command-line use otherwise java-processor will get used  |
 | asset.api.download | true              | you can disable endpoint                                     |
 | asset.api.delete   | true              | when false no delete is possible                             |
+| asset.api.copy   | true              | when false no copy is possible                             |
 | asset.api.batch    | true              | you can disable batch endpoint                               |
 | asset.api.analyse | tru | you can disable analyse endpoint |
 | asset.api.preview  | true              | should only been taken in case of mongo-storage<br />please consider also using outside caching |

diff --git a/commons-asset-api/src/doc/swagger/api-docs.json b/commons-asset-api/src/doc/swagger/api-docs.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "description": "Provides services + rest-controller to handle asset with different storage engines.",
-    "version": "4.0.0",
+    "version": "4.1.0",
     "title": "commons-asset api",
     "contact": {
       "name": "rocketbase.io",
@@ -21,12 +21,16 @@
     },
     {
       "name": "delete",
-      "description": "Delete asset from datastore + db"
+      "description": "Delete asset from filestorage + db"
     },
     {
       "name": "download",
       "description": "Download original binary."
     },
+    {
+      "name": "copy",
+      "description": "Copy source asset on filestorage + db."
+    },
     {
       "name": "preview",
       "description": "Simple preview service."
@@ -425,6 +429,46 @@
         "deprecated": false
       }
     },
+    "/api/asset/{sid}/copy": {
+      "post": {
+        "tags": [
+          "copy"
+        ],
+        "summary": "copy source asset",
+        "description": "response with the copied assetRead of source",
+        "operationId": "copyAssetPOST",
+        "produces": [
+          "*/*"
+        ],
+        "parameters": [
+          {
+            "name": "sid",
+            "in": "path",
+            "description": "id or systemRefId (you've given optionally within upload process)",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/AssetRead"
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          }
+        },
+        "deprecated": false
+      }
+    },
     "/api/asset/{sid}/{size}": {
       "get": {
         "tags": [