fix: Fixed a description error in CreateLink (#698)

beyondstorage · Jul 30, 2021 · 6e541b8 · 6e541b8
1 parent 5ed344b
commit 6e541b8
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/cmd/definitions/bindata/bindata.go b/cmd/definitions/bindata/bindata.go
diff --git a/definitions/operations.toml b/definitions/operations.toml
@@ -299,8 +299,10 @@ Will create a link object.
 # Behavior
 
 - `path` and `target` COULD be relative or absolute path.
-- If `target` exists, CreateLink will create a link object on the target.
-- If `path` does not exist, the CreateLink will fail, and no link object will be created anywhere.
+- If `target` not exists, CreateLink will still create a link object to path.
+- If `path` exists:
+  - If `path` is a symlink object, CreateLink will remove the symlink object and create a new link object to path.
+  - If `path` is not a symlink object, CreateLink will return an ErrObjectModeInvalid error when the service does not support overwrite.
 - A link object COULD be returned in `Stat` or `List`.
 - CreateLink COULD implement virtual_link feature when service without native support.
   - Users SHOULD enable this feature by themselves.

diff --git a/types/operation.generated.go b/types/operation.generated.go
@@ -282,8 +282,10 @@ type Linker interface {
 	// # Behavior
 	//
 	// - `path` and `target` COULD be relative or absolute path.
-	// - If `target` exists, CreateLink will create a link object on the target.
-	// - If `path` does not exist, the CreateLink will fail, and no link object will be created anywhere.
+	// - If `target` not exists, CreateLink will still create a link object to path.
+	// - If `path` exists:
+	//   - If `path` is a symlink object, CreateLink will remove the symlink object and create a new link object to path.
+	//   - If `path` is not a symlink object, CreateLink will return an ErrObjectModeInvalid error when the service does not support overwrite.
 	// - A link object COULD be returned in `Stat` or `List`.
 	// - CreateLink COULD implement virtual_link feature when service without native support.
 	//   - Users SHOULD enable this feature by themselves.
@@ -293,8 +295,10 @@ type Linker interface {
 	// # Behavior
 	//
 	// - `path` and `target` COULD be relative or absolute path.
-	// - If `target` exists, CreateLink will create a link object on the target.
-	// - If `path` does not exist, the CreateLink will fail, and no link object will be created anywhere.
+	// - If `target` not exists, CreateLink will still create a link object to path.
+	// - If `path` exists:
+	//   - If `path` is a symlink object, CreateLink will remove the symlink object and create a new link object to path.
+	//   - If `path` is not a symlink object, CreateLink will return an ErrObjectModeInvalid error when the service does not support overwrite.
 	// - A link object COULD be returned in `Stat` or `List`.
 	// - CreateLink COULD implement virtual_link feature when service without native support.
 	//   - Users SHOULD enable this feature by themselves.