Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

docs(api): document isLocked field in stat() response (#1940) (#1956)

Evo217eaa5448d8
diff --git a/docs/en/api/03-filesystem.md b/docs/en/api/03-filesystem.md
index 5e106fc6c..d0b6d67fc 100644
--- a/docs/en/api/03-filesystem.md
+++ b/docs/en/api/03-filesystem.md
@@ -465,12 +465,15 @@ openviking stat viking://resources/my-project/docs/api.md
"mode": 33188,
"modTime": "2024-01-01T00:00:00Z",
"isDir": false,
+ "isLocked": false,
"uri": "viking://resources/docs/api.md"
},
"time": 0.1
}
```
+The `isLocked` field reports whether the path is currently held by a path lock — either the path itself has a valid `.path.ovlock`, or any ancestor directory holds a SUBTREE lock. Returns `false` when the LockManager is unavailable or the lookup fails, so callers can avoid attempting a write only to observe `ResourceBusyError`.
+
---
### mkdir()
diff --git a/docs/zh/api/03-filesystem.md b/docs/zh/api/03-filesystem.md
index 2922095da..cff8409c1 100644
--- a/docs/zh/api/03-filesystem.md
+++ b/docs/zh/api/03-filesystem.md
@@ -465,12 +465,15 @@ openviking stat viking://resources/my-project/docs/api.md
"mode": 33188,
"modTime": "2024-01-01T00:00:00Z",
"isDir": false,
+ "isLocked": false,
"uri": "viking://resources/docs/api.md"
},
"time": 0.1
}
```
+`isLocked` 字段反映路径当前是否被 path lock 持有:路径自身存在有效的 `.path.ovlock`,或者任一祖先目录持有 SUBTREE 锁。当 LockManager 不可用或查询失败时返回 `false`,调用方可据此避免先写入再观察到 `ResourceBusyError`。
+
---
### mkdir()