Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing API documentation for DataPathAddr #33941

Merged
merged 1 commit into from
Jul 6, 2017

Conversation

thaJeztah
Copy link
Member

Commit 0307fe1 added
a new DataPathAddr property to the swarm/init and swarm/join
endpoints. This property was not yet added to the
documentation.

Relates to #32717

ping @fcrisciani PTAL

COmmit 0307fe1 added
a new `DataPathAddr` property to the swarm/init and swarm/join
endpoints. This property was not yet added to the
documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@fcrisciani
Copy link
Contributor

fcrisciani commented Jul 5, 2017

LGTM, thanks for adding it

@thaJeztah
Copy link
Member Author

sigh; looks like there were issues with Docker Hub search

we need to rewrite that test to a unit test, no need to test if Docker Hub is working

10:53:52 ----------------------------------------------------------------------
10:53:52 FAIL: docker_cli_search_test.go:103: DockerSuite.TestSearchWithLimit
10:53:52 
10:53:52 docker_cli_search_test.go:122:
10:53:52     c.Assert(outSlice, checker.HasLen, limit+2) // 1 header, 1 carriage return
10:53:52 ... obtained []string = []string{"NAME                                    DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED", "jenkins                                 Official Jenkins Docker image                   2938      [OK]       ", "docker                                  Docker in Docker!                               509       [OK]       ", "konradkleine/docker-registry-frontend   Browse and modify your Docker registry in ...   152                  [OK]", "plexinc/pms-docker                      Official Plex Media Server Docker Repo          129                  [OK]", "docker-dev                              Docker is an open source project to pack, ...   66        [OK]       ", "nodered/node-red-docker                 Node-RED Docker images.                         63                   [OK]", "datadog/docker-dd-agent                 Docker container for the Datadog Agent.         56                   [OK]", "docker/docker-bench-security            Docker Bench checks for dozens of common b...   24                   [OK]", "dockercore/docker                                                                       20                   [OK]", "docker/migrator                         Tool to migrate Docker images from a v1 re...   4                    [OK]", ""}
10:53:52 ... n int = 102
10:53:52 
10:49:53 ----------------------------------------------------------------------
10:49:53 FAIL: docker_cli_search_test.go:103: DockerSuite.TestSearchWithLimit
10:49:53 
10:49:53 docker_cli_search_test.go:122:
10:49:53     c.Assert(outSlice, checker.HasLen, limit+2) // 1 header, 1 carriage return
10:49:53 ... obtained []string = []string{"NAME      DESCRIPTION   STARS     OFFICIAL   AUTOMATED", ""}
10:49:53 ... n int = 102
10:49:53 

@tiborvass
Copy link
Contributor

LGTM

@thaJeztah
Copy link
Member Author

author LGTM

@thaJeztah thaJeztah merged commit 9d95740 into moby:master Jul 6, 2017
@thaJeztah thaJeztah deleted the update-api-docs branch July 6, 2017 01:35
@thaJeztah thaJeztah changed the title Add missing API documentatoin for DataPathAddr Add missing API documentation for DataPathAddr Jul 6, 2017
@@ -26,6 +26,8 @@ keywords: "API, Docker, rcli, REST, documentation"
the daemon. This endpoint is experimental and only available if the daemon is started with experimental features
enabled.
* `GET /images/(name)/get` now includes an `ImageMetadata` field which contains image metadata that is local to the engine and not part of the image config.
* `POST /swarm/init` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic
* `POST /swarm/join` now accepts a `DataPathAddr` property to set the IP-address or network interface to use for data traffic
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, put it under the wrong API version

@thaJeztah thaJeztah added this to the 17.06.0 milestone Jul 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants