Yicheng Qin
d52cb2e5d9
docs: add watch command and correct the example
2015-07-20 14:49:01 -07:00
Michael Schurter
f52db1c08e
docs: add back original example w/index=prevIndex
2015-07-13 23:04:39 -07:00
Michael Schurter
b94f6595e6
docs: rewrite existing docs instead of adding a new section
...
@xiang90 pointed out my earlier commit duplicated a lot of things that
were mentioned earlier in the doc.
This time around I tried just making some gotchas more explicit in the
existing docs instead of just tacking new stuff onto the end.
2015-07-13 23:03:59 -07:00
Alex Chan
0c63e16ae0
docs: small fixes to spelling and similar
...
This commit is a collection of fixes to spelling, capitalisation
and spacing. No substantial changes.
2015-05-13 11:45:00 +01:00
Rob Szumski
bfd4a29f67
docs: fix code block formatting
2015-04-28 11:17:13 -07:00
Rob Szumski
bd54f46d1b
docs: remove absolute links to other docs
2015-04-22 11:47:52 -07:00
Mateus Braga
7f833ced2b
docs: add clarity about the 1000 events history
...
When talking about missing events on a particular key, the 1000 event history
limit can be understood as being per key, instead of etcd-wide events. Make it
clear that it is across all etcd keys.
2015-03-27 13:02:48 -04:00
Yicheng Qin
c990099008
docs: fix stats response in api.md
2015-02-09 11:48:54 -08:00
Omer Katz
f5afe3cc34
Fixed typo in API documentation.
2015-01-30 14:14:18 -08:00
Yicheng Qin
37dde76cd5
*: remove consistent-get related stuffs
2015-01-15 22:21:53 -08:00
Yicheng Qin
245e23ca47
docs: use 2.0 docs
2015-01-14 17:27:35 -08:00
周春寅
42ae6e5f5b
docs: fix send rate usage in api.md
2015-01-13 23:18:12 +08:00
Vipin Jain
3f64c677e1
modify directory deletion sequence
2014-12-13 16:22:36 -08:00
Alan LaMielle
2b7af3d101
doc: uses spaces consistently in sample JSON
...
Replaces spurious uses of tabs with four spaces. Removes strange
unicode space character with standard space character.
2014-12-02 06:43:07 -08:00
Kelsey Hightower
d06d55193b
doc: fix listing a directory
2014-10-13 10:59:24 -07:00
Jonathan Boulle
13c20b1b64
docs: update error codes in api document
2014-09-24 15:59:40 -07:00
Yicheng Qin
3fc68f00f0
Merge pull request #956 from jurmous/patch-2
...
Remove an invalid comma from api.md example
2014-08-25 08:20:31 -07:00
jurmous
8f629aae4b
Remove an invalid comma from api.md example
2014-08-25 11:09:15 +02:00
jurmous
dead5e0eef
Adding missing comma to api.md
...
Invalid json example
2014-08-25 10:55:56 +02:00
Deyuan Deng
e491c16afa
Fix Typo in api.md.
2014-08-24 10:42:47 -04:00
grossws
616db55e08
Typo fix
2014-08-11 15:57:00 +04:00
Rob Szumski
686837227e
fix(docs/api): mention version endpoint is per instance
2014-07-28 11:28:16 -07:00
Rob Szumski
f2652f005e
Merge pull request #882 from cap10morgan/patch-1
...
add the /version endpoint to the API docs
2014-07-28 11:26:24 -07:00
Brandon Philips
05bfb369ef
Documentation: add note about consistent=true
2014-07-13 11:07:59 -08:00
Wes Morgan
0593a52107
add the /version endpoint to the API docs
...
I had to find this by accident. It should be documented here.
2014-07-08 17:26:47 -04:00
Blake Mizerany
fb32a999a6
doc: add note about removal of leader mod
2014-06-19 17:10:34 -07:00
Brandon Philips
0eba3c9000
feat(Documentation): document the entire admin machines API
...
Flesh out this document a bit more completely.
2014-05-20 20:25:34 -07:00
Brandon Philips
c3aab42959
fix(Documentation): update based on standby refactor
...
These docs were not updated after the refactoring of the standy mode.
Fix that now.
2014-05-20 20:07:47 -07:00
Brandon Philips
62560f9959
fix(server): add user facing remove API
...
This was accidently removed as we refactored the standy stuff. Re-add this
user facing remove endpoint that matches the config endpoints.
2014-05-20 20:01:10 -07:00
Yicheng Qin
8b5d9cc1fb
docs(api): make Cluster Config API part clearer
2014-05-05 18:49:21 -07:00
Yicheng Qin
204f2d38af
docs(api): add Cluster Config API
2014-04-18 18:24:19 -07:00
Yicheng Qin
a2749bad53
docs(modules): make reasons for deprecation much more clear
2014-04-18 10:36:59 -07:00
Yicheng Qin
1eaa9c9899
docs: record module deprecation
2014-04-16 23:24:11 -07:00
Yicheng Qin
1af51ca0c5
docs(ttl): the way to unset ttl
2014-04-14 11:05:52 -07:00
Mikhail Goncharov
a20ce3e7a5
doc(api) correct release lock curl command
...
related to #638 issue - DELETE request body is ignored
typo fixed
2014-03-23 21:53:54 +07:00
Matt Layher
38631395b6
docs(Documentation/api): fix JSON spacing, syntax highlighting
2014-03-20 02:36:35 -04:00
Mikhail Goncharov
b8f59340af
docs(api): updated examples and description of CAS and CAD
2014-03-12 09:33:47 +07:00
Cong Ding
dbed0f7d6a
fix(Documentation/*): fix various typos
2014-03-03 16:12:15 -08:00
Brandon Philips
02a053a4b8
feat(Documentation/api): document file upload
...
This gets asked about a lot int IRC/mailinglist/etc. Fixes this issue:
https://github.com/coreos/etcd/issues/383#issuecomment-31183603
2014-02-23 10:17:05 -08:00
Brandon Philips
035bbc6913
feat(Documentation): add a section on consistent reads
...
We have waited too long to document `consistent=true`. Document it!
2014-02-21 09:39:54 -08:00
Brandon Philips
ba8e5d7add
fix(Documentation): single machine clusters have some stats undefined
...
document that single machine clusters will omit sendBandwidthRate and
sendPkgRate.
Via http://thread.gmane.org/gmane.comp.distributed.etcd/218
2014-02-10 21:58:09 -08:00
Brian Waldon
1fcbc83503
doc(CompareAndSwap): clarify prevIndex in CAS
2014-02-08 07:27:59 -08:00
Brian Waldon
08818886b2
doc(CompareAndDelete): Add missing CAD docs
...
Fixes issue #549
2014-02-08 07:27:33 -08:00
Brian Waldon
0696e5026f
doc(api): Document prevNode
2014-02-07 15:03:15 -08:00
Jonathan Boulle
03ff4c8b76
Missed one
2014-01-25 12:22:37 -08:00
Jonathan Boulle
7992448f6a
Various cleanup to API documentation
2014-01-25 12:08:57 -08:00
Jamu Kakar
823e744ed9
- Fix typo.
2014-01-18 18:28:33 -08:00
Xiang Li
87113f985f
Merge pull request #472 from benbjohnson/fix-error-codes
...
Fix mod/lock and mod/leader return error codes.
2014-01-15 01:14:59 -08:00
Brandon Philips
0f97e3528a
chore(build): use third_party.go
...
use the third_party.go project to replace our update script. This
requires moving a few things around and gets rid of a few annoying bugs:
- You can now bump individual packages
- A new src directory isn't created on build
- Less shell scripting!
- Things get built into ./bin/
2014-01-14 22:14:47 -08:00
Ben Johnson
cde184fdbf
Fix mod/lock and mod/leader return error codes.
2014-01-14 07:57:30 -07:00
