0ct0pu5/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
14162 commits 14 branches 412 tags 338 MiB
Commit graph

53 commits

Author SHA1 Message Date
Vincent Giersch
1f03944950 Documents build API "remote" parameter 
Introduced in Docker v0.4.5 / Remove API v1.1 (#848), the remote
parameter of the API method POST /build allows to specify a buildable
remote URL (HTTPS, HTTP or Git).

Signed-off-by: Vincent Giersch <vincent.giersch@ovh.net>
 2015-02-09 08:49:04 -08:00
Sebastiaan van Stijn
cc0bfccdf4 Replace "base" with "ubuntu" in documentation 
The API documentation uses the "base" image in various
places. The "base" image is deprecated and it is no longer
possible to download this image.

This changes the API documentation to use "ubuntu" in stead.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2015-02-02 13:34:12 -08:00
Tony Miller
4602909566 fix /etc/host typo in remote API docs 
Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
 2015-01-27 19:35:25 -08:00
Tony Miller
08f2fad40b document the ExtraHosts parameter for /containers/create for the remote API 
I think this was added from version 1.15.

Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
 2015-01-27 19:35:24 -08:00
Andrew C. Bodine
32f189cd08 Adds docs for /containers/(id)/attach/ws api endpoint 
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
 2015-01-27 19:35:23 -08:00
Jessica Frazelle
ee78e3f284 Add reference to rename endpoint in correct version & add to new 
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
 2015-01-13 15:22:04 -08:00
Srini Brahmaroutu
21a809d9ae rename a existing container 
Closes #3036

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
 2015-01-13 03:27:17 +00:00
Lorenz Leutgeb
e583cc1eb4 doc: Try to standardise JSON examples 
Fixed:
 * Invalid JSON
 * Inconsistent spacing at colon

Expression for binary data streams (line 468 vs. 1474) remain inconsistent.
Could fix that too, if you like.

Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
 2015-01-03 18:20:59 +01:00
Sven Dowideit
35873e747d Document that there is a delay before the --restart policy restart, and that its double the last one 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)

Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
 2014-12-30 12:36:04 +10:00
Fred Lifton
5df189a1b0 Merge pull request #9682 from SvenDowideit/scottstamp-stale-links-pr-carry 
Scottstamp stale links pr carry
 2014-12-17 16:03:55 -08:00
Sven Dowideit
fbb9223b1a add Scott's link checker script, and fix what it finds 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
 2014-12-16 14:46:25 +10:00
Kamil Domanski
51da97628a Add available filters for containers, images and events to API docs. 
Signed-off-by: Kamil Domański <kamil@domanski.co> (github: kdomanski)
 2014-12-15 16:51:29 +01:00
Kamil Domanski
37bdb05615 Add container list filtering to API docs. 
Signed-off-by: Kamil Domański <kamil@domanski.co> (github: kdomanski)
 2014-12-15 16:50:56 +01:00
Jonathan A. Sternberg
eb7d646a44 Fixing docs formatting for the forcerm flag on docker build 
Signed-off-by: Jonathan A. Sternberg <jonathansternberg@gmail.com>
 2014-12-04 12:35:31 -05:00
Jean-Paul Calderone
0888c1880f Update the most recent released version of the docs as well. 
Signed-off-by: Jean-Paul Calderone <exarkun@twistedmatrix.com>
 2014-12-03 17:14:08 -05:00
Jessie Frazelle
39284be960 Merge pull request #9263 from cpuguy83/docs_cleanup_exec_api 
Cleanup exec API docs and available params
 2014-11-24 13:35:45 -08:00
Richard Metzler
91a8b916b0 Empty Line should fix Markdown unordered list 
Without the line break the list would render as one single paragraph.
 2014-11-23 23:57:43 +01:00
Brian Goff
d4ba00bd42 Cleanup exec API docs and available params 
Adds pertitent information about what is expected in the json payload
and comments out unsupported (exec) features in runConfig.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
 2014-11-21 21:11:07 -05:00
Doug Davis
814bc06d7b Add missing comma in docs 
Found by Michael Voznesensky <voznesenskym@gmail.com>

Signed-off-by: Doug Davis <dug@us.ibm.com>
 2014-11-11 15:18:20 -08:00
Brian Goff
e86223e7b3 Bring API docs inline with 1.3 
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
 2014-11-05 09:38:44 -05:00
Alexandr Morozov
9eb8fcd58a Merge pull request #8390 from MalteJ/set-macaddress 
Adding docker-cli run param to set MAC address
 2014-11-04 07:54:59 -08:00
Peter Ericson
4437573c96 Fix typo in api docs: stdou -> stdout 2014-11-03 10:52:50 +00:00
Malte Janduda
f2df38050e Adding docker-cli run param to set MAC address 
Signed-off-by: Malte Janduda <mail@janduda.net>
 2014-11-01 15:35:09 +01:00
Huayi Zhang
f6140060e3 Fix commit api document 
The commit message field should be `comment`, not `m`
https://github.com/docker/docker/blob/master/api/server/server.go#L478

Signed-off-by: Huayi Zhang <irachex@gmail.com>
 2014-10-16 18:10:58 +08:00
Sven Dowideit
a64ff0bf7a The basics page moved, update link. 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-10-15 16:48:43 +10:00
Victor Vieux
88a41aa7d1 Merge pull request #8470 from fgrehm/patch-3 
docs: Remove `Detach` parameter from Exec Create example
 2014-10-09 15:25:51 -07:00
Jessica Frazelle
4c6b7cd1b5 Revert "Change content-type for json stream to application/x-json-stream." 
This reverts commit 10ab2089ce.

Conflicts:
	api/client/utils.go
	docs/sources/reference/api/docker_remote_api.md

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
 2014-10-09 13:17:47 -07:00
Fabio Rehm
2fd0e8eb5f docs: Remove Detach parameter from Exec Create example 
Signed-off-by: Fabio Rehm <fgrehm@gmail.com>
 2014-10-08 10:31:12 -03:00
Fabio Rehm
6480b30a99 docs: Update docker exec examples 
Signed-off-by: Fabio Rehm <fgrehm@gmail.com>
 2014-10-03 01:13:59 -03:00
Fred Lifton
f852233a01 Merge pull request #8313 from duglin/Issue4877 
Add missing "tag" parameter to tag API - Issue #4877
 2014-10-01 10:34:57 -07:00
James Turnbull
1d199f2d85 Merge pull request #8286 from ClusterHQ/8285-volume-api-docs 
Document Volumes and Binds
 2014-09-30 15:53:41 -04:00
Vishnu Kannan
021ecb1d13 Adding exec remote API documentation along with minor code cleanup. 
Docker-DCO-1.1-Signed-off-by: Vishnu Kannan <vishnuk@google.com> (github: vishh)
 2014-09-30 18:26:58 +00:00
Doug Davis
ee0b64f7a7 Add missing "tag" parameter to tag API 
Closes #4877

Signed-off-by: Doug Davis <dug@us.ibm.com>
 2014-09-30 10:53:29 -07:00
Jean-Paul Calderone
8e70d553f9 Document Volumes and Binds 
Signed-off-by: Jean-Paul Calderone <jean-paul@clusterhq.com>
 2014-09-29 14:59:48 -04:00
James Turnbull
2682393ce1 Merge pull request #8227 from SvenDowideit/list-container-events 
The list of events that 'grep' told me about
 2014-09-29 14:34:48 -04:00
Srini Brahmaroutu
c7f3fdc629 Documenting Container Tty resize api 
Addresses #7840

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
 2014-09-26 16:26:21 +00:00
SvenDowideit
71e28f9d64 Add the 2 image events found using git grep 'Job("log"' 
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
 2014-09-26 11:55:36 +10:00
SvenDowideit
05060a7c94 The list of events that 'grep' told me about 
docker(master) $ git grep 'LogEvent("' | sed 's/.*("//' | sed 's/").*//'
| sort | uniq | paste -s -d","
create,destroy,die,export,kill,pause,restart,start,stop,unpause

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
 2014-09-26 11:25:36 +10:00
Victor Vieux
42ec80bec0 Merge pull request #8101 from jfrazelle/6974-correct-ct-json-stream 
Change content-type for json stream to application/x-json-stream.
 2014-09-23 11:24:31 -07:00
Sven Dowideit
ab43ad7d5f Apply @tedyoung's changes to the entire set of API docs. 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-09-23 10:09:49 +10:00
Ted M. Young
f304d4b190 Misc. fixes and formatting clean-up 
Cleaned up and corrected some invalid "example responses".
Added some missing double-quotes for examples that resulted in invalid JSON.
Other general cleanup of stray characters and typos.

Docker-DCO-1.1-Signed-off-by: Ted M. Young <tedyoung@gmail.com> (github: SvenDowideit)
 2014-09-23 10:09:49 +10:00
Jessica Frazelle
10ab2089ce Change content-type for json stream to application/x-json-stream. 
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
 2014-09-22 10:29:56 -07:00
Sven Dowideit
db9f8ba55c Add a little description of the image tarball format. 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-09-18 10:40:55 +10:00
Jean-Paul Calderone
d758da386a Add some documentation for the RestartPolicy feature. 
Signed-off-by: Jean-Paul Calderone <jean-paul@clusterhq.com>
 2014-09-16 17:40:56 -04:00
Sven Dowideit
4352ea7b0a Added missing 't' from the end of the /images/{{id}}/get eg. 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-09-16 15:27:44 +10:00
Srini Brahmaroutu
788e4acaa3 Change the copy command Content-Type header to x-tar 
Addresses #6107

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
 2014-09-15 10:45:06 -07:00
Francisco Souza
fe5b72e7bb docs/reference/api: fix typo in docs 
Signed-off-by: Francisco Souza <f@souza.cc>
 2014-09-12 13:57:43 -03:00
Lakshan Perera
7b1fdd6c04 Fixed a typo in docs (outpu -> output). 
Signed-off-by: Lakshan Perera <lakshan@laktek.com>
 2014-09-11 09:09:59 +00:00
Sven Dowideit
f36dfbdcaf Reformat the API docs so I can read them 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-09-09 16:17:38 +10:00
Sven Dowideit
77fa306d63 Update export, copy and build API to sat 'TAR STREAM' for all versions. 
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
 2014-09-08 11:54:21 +10:00