Add tracking issue for GSP-654 & Add comments for List

beyondstorage · Jul 13, 2021 · 5c704a9 · 5c704a9
1 parent f57c90f
commit 5c704a9
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 5 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
@@ -225,10 +225,18 @@ results = ["meta"]
 local = true
 
 [storager.op.list]
-description = "will return list a specific path."
 params = ["path"]
 pairs = ["list_mode"]
 results = ["oi"]
+description = """
+will return list a specific path.
+
+## Behavior
+
+- Service SHOULD support default `ListMode`.
+- Service SHOULD implement `ListModeDir` without the check for `VirtualDir`.
+- Service DON'T NEED to `Stat` while in `List`.
+"""
 
 [storager.op.read]
 description = "will read the file's data."

diff --git a/docs/rfcs/654-unify-list-behavior.md b/docs/rfcs/654-unify-list-behavior.md
@@ -1,7 +1,7 @@
 - Author: JinnyYi <github.com/JinnyYi>
 - Start Date: 2021-07-07
 - RFC PR: [beyondstorage/go-storage#654](https://github.com/beyondstorage/go-storage/pull/654)
-- Tracking Issue: [beyondstorage/go-storage#0](https://github.com/beyondstorage/go-storage/issues/0)
+- Tracking Issue: [beyondstorage/go-storage#657](https://github.com/beyondstorage/go-storage/issues/657)
 
 # GSP-654: Unify List Behavior
 

diff --git a/types/operation.generated.go b/types/operation.generated.go
@@ -594,8 +594,20 @@ type Storager interface {
 	DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)
 
 	// List will return list a specific path.
+	//
+	// ## Behavior
+	//
+	// - Service SHOULD support default `ListMode`.
+	// - Service SHOULD implement `ListModeDir` without the check for `VirtualDir`.
+	// - Service DON'T NEED to `Stat` while in `List`.
 	List(path string, pairs ...Pair) (oi *ObjectIterator, err error)
 	// ListWithContext will return list a specific path.
+	//
+	// ## Behavior
+	//
+	// - Service SHOULD support default `ListMode`.
+	// - Service SHOULD implement `ListModeDir` without the check for `VirtualDir`.
+	// - Service DON'T NEED to `Stat` while in `List`.
 	ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)
 
 	// Metadata will return current storager metadata.