feat: API to save external links as attachments

halo-dev · Jul 24, 2024 · 5b4f691 · 5b4f691
1 parent 2a807b7
commit 5b4f691
Show file tree

Hide file tree

Showing 343 changed files with 839 additions and 377 deletions.
diff --git a/api-docs/openapi/v3_0/aggregated.json b/api-docs/openapi/v3_0/aggregated.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.17.0-SNAPSHOT"
+    "version": "2.18.0-SNAPSHOT"
   },
   "servers": [
     {
@@ -2250,6 +2250,36 @@
         ]
       }
     },
+    "/apis/api.console.halo.run/v1alpha1/attachments/external-transfer": {
+      "post": {
+        "operationId": "ExternalTransferAttachment",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExternalTransferRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "default": {
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Attachment"
+                }
+              }
+            },
+            "description": "default response"
+          }
+        },
+        "tags": [
+          "AttachmentV1alpha1Console"
+        ]
+      }
+    },
     "/apis/api.console.halo.run/v1alpha1/attachments/upload": {
       "post": {
         "operationId": "UploadAttachment",
@@ -17046,6 +17076,28 @@
           }
         }
       },
+      "ExternalTransferRequest": {
+        "required": [
+          "externalUrl",
+          "policyName"
+        ],
+        "type": "object",
+        "properties": {
+          "externalUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "filename": {
+            "type": "string"
+          },
+          "groupName": {
+            "type": "string"
+          },
+          "policyName": {
+            "type": "string"
+          }
+        }
+      },
       "FileReverseProxyProvider": {
         "type": "object",
         "properties": {
@@ -19726,12 +19778,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },
@@ -19861,6 +19913,15 @@
           }
         }
       },
+      "ReasonAttributes": {
+        "type": "object",
+        "properties": {
+          "empty": {
+            "type": "boolean"
+          }
+        },
+        "description": "Attributes used to transfer data"
+      },
       "ReasonList": {
         "required": [
           "first",
@@ -19971,13 +20032,7 @@
         "type": "object",
         "properties": {
           "attributes": {
-            "type": "object",
-            "properties": {
-              "empty": {
-                "type": "boolean"
-              }
-            },
-            "description": "Attributes used to transfer data"
+            "$ref": "#/components/schemas/ReasonAttributes"
           },
           "author": {
             "type": "string"
@@ -21207,11 +21262,8 @@
           "data": {
             "type": "object",
             "additionalProperties": {
-              "type": "array",
-              "items": {
-                "type": "string",
-                "format": "byte"
-              }
+              "type": "string",
+              "format": "byte"
             }
           },
           "kind": {
@@ -21626,12 +21678,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },

diff --git a/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_console.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.17.0-SNAPSHOT"
+    "version": "2.18.0-SNAPSHOT"
   },
   "servers": [
     {
@@ -117,6 +117,36 @@
         ]
       }
     },
+    "/apis/api.console.halo.run/v1alpha1/attachments/external-transfer": {
+      "post": {
+        "operationId": "ExternalTransferAttachment",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExternalTransferRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "default": {
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Attachment"
+                }
+              }
+            },
+            "description": "default response"
+          }
+        },
+        "tags": [
+          "AttachmentV1alpha1Console"
+        ]
+      }
+    },
     "/apis/api.console.halo.run/v1alpha1/attachments/upload": {
       "post": {
         "operationId": "UploadAttachment",
@@ -4053,6 +4083,28 @@
           }
         }
       },
+      "ExternalTransferRequest": {
+        "required": [
+          "externalUrl",
+          "policyName"
+        ],
+        "type": "object",
+        "properties": {
+          "externalUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "filename": {
+            "type": "string"
+          },
+          "groupName": {
+            "type": "string"
+          },
+          "policyName": {
+            "type": "string"
+          }
+        }
+      },
       "GrantRequest": {
         "type": "object",
         "properties": {
@@ -5141,12 +5193,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },
@@ -5652,12 +5704,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },

diff --git a/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_extension.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.17.0-SNAPSHOT"
+    "version": "2.18.0-SNAPSHOT"
   },
   "servers": [
     {
@@ -10668,12 +10668,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },
@@ -11475,11 +11475,8 @@
           "data": {
             "type": "object",
             "additionalProperties": {
-              "type": "array",
-              "items": {
-                "type": "string",
-                "format": "byte"
-              }
+              "type": "string",
+              "format": "byte"
             }
           },
           "kind": {
@@ -11858,12 +11855,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },

diff --git a/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_public.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.17.0-SNAPSHOT"
+    "version": "2.18.0-SNAPSHOT"
   },
   "servers": [
     {

diff --git a/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json b/api-docs/openapi/v3_0/apis_uc.api_v1alpha1.json
@@ -2,7 +2,7 @@
   "openapi": "3.0.1",
   "info": {
     "title": "Halo",
-    "version": "2.17.0-SNAPSHOT"
+    "version": "2.18.0-SNAPSHOT"
   },
   "servers": [
     {
@@ -1582,12 +1582,12 @@
           },
           "visible": {
             "type": "string",
+            "default": "PUBLIC",
             "enum": [
               "PUBLIC",
               "INTERNAL",
               "PRIVATE"
-            ],
-            "default": "PUBLIC"
+            ]
           }
         }
       },

diff --git a/api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java b/api/src/main/java/run/halo/app/core/extension/service/AttachmentService.java
@@ -91,4 +91,15 @@ Mono<Attachment> upload(@NonNull String policyName,
      */
     Mono<URI> getSharedURL(Attachment attachment, Duration ttl);
 
+    /**
+     * Transfer external links to attachments.
+     *
+     * @param externalUrl external url
+     * @param policyName policy name
+     * @param groupName group name
+     * @param filename filename
+     * @return attachment
+     */
+    Mono<Attachment> externalTransfer(@NonNull URI externalUrl, @NonNull String policyName,
+        String groupName, String filename);
 }