v3 doc need more example
Open
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 203
- Forks
- 58
- PR merge metrics
- No merged PRs in 30d
Description
v3 doc need more example, such as api return schema like:
events = { {
kv = {
create_revision = "42",
key = "/aaa/bbb",
mod_revision = "43",
value = "abc",
version = "2"
}
}, {
kv = {
key = "/xxx/yyy",
mod_revision = "44"
},
type = "DELETE"
} },
header = {
cluster_id = "14841639068965178418",
member_id = "10276657743932975437",
raft_term = "2",
revision = "44"
}
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name a documentation file or test; first locate the v3 documentation in the repository and review its existing API response examples. Add the supplied etcd response schema example, and consider the work done when the v3 docs clearly show this return shape.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100