Sebastiaan van Stijn
c0969ed3d8
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-01-28 22:54:10 +01:00
Andrew C. Bodine
51060ee07a
Adds docs for /containers/(id)/attach/ws api endpoint
...
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
2015-01-21 18:37:08 -08:00
Lorenz Leutgeb
975f5b0c28
doc: Broaden JSON standardisation by patching
...
This is:
git format-patch -1 --stdout HEAD \
| patch -p1 docs/sources/reference/api/docker_remote_api_v1.*.md
Applying the changes I initially made on the docs for v1.15 to all
other versions led to acceptable results.
Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
2015-01-05 11:45:10 +01: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
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
Andrew C. Bodine
f9cdad3272
Cleanup: fixes start response status code typo in examples
...
Signed-off-by: Andrew C. Bodine <acbodine@us.ibm.com>
2014-11-18 11:32:51 -08:00
Peter Ericson
4437573c96
Fix typo in api docs: stdou -> stdout
2014-11-03 10:52:50 +00: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
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
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
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
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
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
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
Victor Vieux
2d8695761d
more updates
...
Signed-off-by: Victor Vieux <vieux@docker.com>
2014-09-01 18:41:42 +00:00
Anand Patil
eac6a5d789
v1.13 and 1.14 api docs now match runconfig/config.go
2014-09-01 18:33:13 +00:00
SvenDowideit
b0edced87f
Fix the other API docs to use an array of key/values
...
as per #7706
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-08-26 11:36:25 +10:00
Solomon Hykes
1d10c55aec
Move remote API config out of daemon/
...
Signed-off-by: Solomon Hykes <solomon@docker.com>
2014-08-13 19:25:51 +00:00
Lachlan Coote
a5c5dc121c
#1852 Remote API documentation incorrect regarding private registries
...
Issues addressed:
- Remote API doco refers to "registry" parameter which is not supported
- Neglects to mention "tag" parameter which is supported
- Offers no guidance on pushing to private registries
Changes made:
- As directed in review comments, `registry` removed from all api versions (1.0-1.14)
- Have added documentation for `tag` parameter and guidance on private registries for versions 1.10-1.14 (I have only validated this on .10)
Docker-DCO-1.1-Signed-off-by: Lachlan Coote <lachlan.t.coote@gmail.com> (github: lcoote)
2014-08-01 15:58:01 -07:00
Julien Bordellier
2d84b877bd
Adding the query parameters to insert api call for all <= 1.10 and
...
removing the insert documentation for > 1.10 since it has been removed
in 1.11. This commit fixes #7183
Docker-DCO-1.1-Signed-off-by: Julien Bordellier <me@julienbordellier.com> (github: jstoja)
2014-07-26 13:03:04 +02:00
Victor Vieux
b3ee9ac74e
update go import path and libcontainer
...
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-07-24 22:19:50 +00:00
Victor Vieux
cdfdbe9bc6
proper rebase
...
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-07-11 22:39:43 +00:00
Alexandr Morozov
1dc0caf9c0
Implement tail for docker logs
...
Fixes #4330
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
2014-07-01 23:44:12 +04:00
SvenDowideit
fde10cf87b
blindly make all uses of e\.?g\.? into e.g.,
...
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-07-01 09:55:19 +10:00
Christian Berendt
b44e13ae02
Fixed typographical erros in the documentation
...
Used the RETF rules provided by Wikipedia to fix some typographical
errors in the Markdown files of the documentation with the following
script:
https://github.com/openstack/openstack-doc-tools/tree/master/cleanup/retf
Docker-DCO-1.1-Signed-off-by: Christian Berendt <berendt@b1-systems.de> (github: berendt)
Docker-DCO-1.1-Signed-off-by: Christian Berendt <berendt@b1-systems.de> (github: SvenDowideit)
2014-07-01 09:54:20 +10:00
Michael Crosby
e35a9a7def
Merge pull request #6683 from vieux/add_links_inspect
...
add links to inspect for 'linking' containers
2014-06-26 17:33:02 -07:00
Victor Vieux
250b0d070c
add doc
...
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-06-26 23:36:29 +00:00
Tibor Vass
5743151118
Merge pull request #6649 from vieux/fix_api_return_codes_start_stop
...
return 304 is status isn't modified in start and stop
2014-06-25 19:10:19 -04:00
Abel Muiño
901a47daff
Document the pause and unpause commands available on API v1.12 onwards
...
Docker-DCO-1.1-Signed-off-by: Abel Muiño <amuino@gmail.com> (github: amuino)
2014-06-25 00:41:57 +02:00
Victor Vieux
53b036032d
return 304 is status isn't modified in start and stop
...
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-06-24 18:31:56 +00:00
SvenDowideit
cf513185b0
move api docs to APIv1.13
...
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-06-24 12:25:18 +10:00