Commit graph

401 commits

Author SHA1 Message Date
Sven Dowideit
2cce7bf33a Merge pull request #26306 from deployable/patch-1
Remote API documentation consistancy
2016-09-12 10:52:30 +10:00
Matt Hoyle
e0a552504e Keep headings consistant in API documentation
The "Stream details" sections are currently a part of the Status codes list.

This change moves them out to the same level as other surrounding sections.

Use () for a paramaters

Remove query param from end point heading

Signed-off-by: Matt Hoyle <matt@deployable.co>
2016-09-10 12:27:41 +10:00
Charles Smith
6f0502b89b Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage
Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
2016-09-07 10:38:59 -07:00
Misty Stanley-Jones
a2a0a03e2b Add response to swarm/init example (fixes #25625
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-06 08:39:53 -07:00
Vincent Demeester
fb8b6438f2
Add health status as action on events documentations
This was missing from the docs for 1.12.0.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-09-04 18:01:57 +02:00
Misty Stanley-Jones
82304abd80 Sanitize uses of Swarm as a proper and improper noun
Fixes #24905

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-08-30 11:04:41 -07:00
yuexiao-wang
aedf95e640 Modify link for hub and registry
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-08-30 16:37:03 +08:00
Yong Tang
5118dd2992 Update documentation for validation of --ip and ip6.
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-08-25 22:11:56 -07:00
Vincent Demeester
48ff20c795 Merge pull request #26016 from vdemeester/docs-restart-policy-api-changes
Update docker remote api to mention restart policy validation
2016-08-26 07:57:53 +02:00
Vincent Demeester
a011a94be7
Update docker remote api to mention restart policy validation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-08-25 17:03:18 +02:00
yuexiao-wang
530668cb22 Replace docker command from 'docker daemon' to 'dockerd'
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-08-25 17:04:44 +08:00
Vincent Demeester
daf454d8cd Merge pull request #25719 from eskaaren/master
You can force leave swarm
2016-08-22 09:15:37 +02:00
Yong Tang
6c5c34d50d Add --force in docker volume rm to fix out-of-band volume driver deletion
This fix tries to address the issue in raised #23367 where an out-of-band
volume driver deletion leaves some data in docker. This prevent the
reuse of deleted volume names (by out-of-band volume driver like flocker).

This fix adds a `--force` field in `docker volume rm` to forcefully purge
the data of the volume that has already been deleted.

Related documentations have been updated.

This fix is tested manually with flocker, as is specified in #23367.
An integration test has also been added for the scenario described.

This fix fixes #23367.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-08-18 18:01:25 -07:00
Vincent Demeester
426046db3a Merge pull request #25708 from timfeirg/master
expose RemovalInProgress in StateString #25652
2016-08-18 21:54:48 +02:00
timfeirg
37466cc8c8 expose RemovalInProgress in StateString #25652
Signed-off-by: timfeirg <kkcocogogo@gmail.com>
2016-08-18 11:25:27 +08:00
Sebastiaan van Stijn
a5ba032c74 Add missing docs about binary remote contexts
This feature was added in docker 1.8, through
7491f9a9c1.

However, the API docs ended up in the wrong
API version (1.19 instead of 1.20), so were
never included in future API docs.

Also, the CLI docs got lost during splitting
up the cli.md docs into separate files;
561bfb268d

This moves the API docs to the correct
versions, and restores the CLI documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-17 16:15:59 +02:00
Sebastiaan van Stijn
45cb33e65c Merge pull request #25704 from thaJeztah/cleanup-api-markdown
Cleanup API docs Markdown formatting and wording
2016-08-17 10:39:45 +02:00
Tõnis Tiigi
9a3e7d9e34 Merge pull request #25701 from WeiZhang555/update-conflict-rm-restart
Forbid update restart policy of container with AutoRemove flag
2016-08-16 10:37:45 -07:00
Sebastiaan van Stijn
641e1564cf Merge pull request #25757 from eskaaren/create_service_id
Capital D in "ID" returned when creating service
2016-08-16 17:01:22 +02:00
Eivin Giske Skaaren
69e481af4e "Annotations" not a parameter
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 15:17:26 +02:00
Eivin Giske Skaaren
9eb2ec799e Capital D in "ID" returned when creating service
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 13:43:23 +02:00
Sebastiaan van Stijn
eb24e9bbd3 Cleanup API docs Markdown formatting and wording
Synchronize formatting between versions, and
update wording to be consistent.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-16 13:22:47 +02:00
Eivin Giske Skaaren
c59bc53727 Add doc for inspect swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 12:49:33 +02:00
Zhang Wei
4754c64ab5 Forbid update restart policy of container with AutoRemove flag
"--restart" and "--rm" are conflict options, if a container is started
with AutoRemove flag, we should forbid the update action for its Restart
Policy.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
2016-08-16 15:36:13 +08:00
Eivin Giske Skaaren
033482d9ff You can force leave swarm
Signed-off-by: Eivin Giske Skaaren <eivin@sysmystic.com>
2016-08-16 09:32:45 +02:00
Sebastiaan van Stijn
9079d5ccbb Merge pull request #25706 from thaJeztah/add-authorization-header-to-api-docs
Add X-Registry-Auth header to service API docs
2016-08-15 21:54:06 +02:00
Sebastiaan van Stijn
7cdd693d5d
Move sysctls to correct API version
Commit 067b510dfc move the
sysctls feature to the right API version, but
missed this one.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-15 12:02:54 +02:00
Sebastiaan van Stijn
bde35ef18a
Add X-Registry-Auth header to service API docs
The service create/update endpoints support
passing registry-authentication information,
but this was not documented.

This adds the missing information about passing
a X-Registry-Auth header.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-15 11:53:12 +02:00
Sebastiaan van Stijn
419d2ad0f8
Update API docs example for image load response
Commit 353af0b3ec updated
the `/image/load` endpoint to consistendly return
JSON, but did not update the associated documentation.

This updates the example response in the documentation
to match the actual response.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-12 11:57:34 +02:00
Sebastiaan van Stijn
d8240c8e27 Merge pull request #25564 from coolljt0725/fix_inspect_network
Fix inspect network show gateway with mask
2016-08-12 11:11:09 +02:00
Lei Jitang
096bb5fb07 Fix inspect network show gateway with mask
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2016-08-11 21:08:54 -04:00
Sebastiaan van Stijn
5b68177a6e Merge pull request #25548 from thaJeztah/plugin-api-docs
Add API documentation for experimental plugin features
2016-08-11 21:52:04 +02:00
Vincent Demeester
a3432c2fdb Merge pull request #25604 from allencloud/add-missing-fields-in-volume-api
add fields in volume api for 1.24, 1.25
2016-08-11 14:03:25 +02:00
allencloud
b015fd4fb3 add fields in volume api for 1.24, 1.25
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-08-11 19:56:17 +08:00
Vincent Demeester
e26c35408d Merge pull request #25590 from thaJeztah/add-node-force-remove-api-docs
Add node remove "force" parameter to 1.25 API docs
2016-08-11 09:47:41 +02:00
Sebastiaan van Stijn
ceed39b530
Fix events "since" / "until" query parameter description
The "since" query parameter can be *useful*
for polling (in combination with "until"), but
doesn't actualy stop the endpoint from streaming
events.

This patch updates the description to better
clarify that "since" does not make the endpoint
non-streaming.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-10 23:17:04 +02:00
Sebastiaan van Stijn
06fa5c12e8
Add node remove "force" parameter to 1.25 API docs
This parameter was documented for 1.24, but we
forgot to add it to the 1.25 docs as well.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-10 23:01:17 +02:00
Sebastiaan van Stijn
83d11710eb Add API documentation for experimental plugin features
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-10 21:15:40 +02:00
Sebastiaan van Stijn
2f167a7609 Merge pull request #25172 from vdemeester/25153-node-delete-update-api-docs
Add delete and update API documentation
2016-08-10 08:01:13 +02:00
Sebastiaan van Stijn
06e3ea1417 Merge pull request #25530 from thaJeztah/docs-update-image-load-response
docs: add missing "quiet" parameter for image/load and update response
2016-08-09 15:26:16 +02:00
Vincent Demeester
da325c035d
Add delete and update API documentation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-08-09 14:50:46 +02:00
Sebastiaan van Stijn
d13ed38471
docs: add missing "quiet" parameter for image/load and update response
Progress reporting during image load was added
in 415dd86886, but
the corresponding query-parameter was not documented
in the API docs.

This updates the API docs, and adds a response example
both with quiet enabled and disabled.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-09 12:08:33 +02:00
Sebastiaan van Stijn
3892ac7e94
docs: add missing content-type header for image load
Without a content-type header, Go uses a max post size
of 10 megabytes, which makes loading images fail
if they're larger than 10 megabytes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-09 10:56:49 +02:00
Zhang Wei
7df815d2af Add docs for auto-removal on daemon
Docs for #20848: move "--rm" to daemon side.

Add description for introduced API changes.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
2016-08-09 00:47:12 +08:00
Zhang Wei
6dd8e10d6e Wait container's removal via Events API
If AutoRemove is set, wait until client get `destroy` events, or get
`detach` events that implies container is detached but not stopped.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>
2016-08-08 22:46:53 +08:00
Yong Tang
26c913cb60 Update documentation for entrypoint unset with docker run/create
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-08-05 16:35:25 -07:00
Sebastiaan van Stijn
5696c47470 Sync API docs
This synchronizes formatting changes to older
versions of the API

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-05 17:44:58 +02:00
Sebastiaan van Stijn
33bd963cfb
Fix Markdown formatting in API docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-04 14:13:30 +02:00
Vincent Demeester
63d65505b2 Update /node/* api reference documentation
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-08-03 14:55:30 +02:00
Daniel X Moore
397cc85643
409 status code result to create service
Added example 409 status code result to the create service endpoint.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-03 00:46:04 +02:00