Skip to content

Conversation

@dnephin
Copy link
Member

@dnephin dnephin commented Oct 15, 2015

The API docs for this endpoint are incomplete and from what I can tell just wrong in one case.

  • I can't see any reference in the code to a registry param. Maybe it was removed at some point?
  • this endpoint supports two operations (it should probably be split into two endpoints eventually), but each operation supports different sets of args. I tried to clarify which operation uses which args.
  • tags and digest can be included either as part of fromImage or in tag

I think these fixes could probably be backported to the 1.20 api docs as well, but I wanted to get a review of the wording first, then I can copy it.

+kind/docs

Signed-off-by: Daniel Nephin <dnephin@docker.com>
@dnephin dnephin force-pushed the add_digest_to_api_docs branch from 84ba3f0 to 2ec4404 Compare October 15, 2015 20:00
@vdemeester
Copy link
Member

/ping @thaJeztah @moxiegirl

@moxiegirl
Copy link
Contributor

LGTM Thank you @dnephin for the catch.

@thaJeztah
Copy link
Member

Thanks @dnephin LGTM 👍

thaJeztah added a commit that referenced this pull request Oct 16, 2015
@thaJeztah thaJeztah merged commit e2870bd into moby:master Oct 16, 2015
@thaJeztah thaJeztah added this to the 1.9.0 milestone Oct 16, 2015
@thaJeztah
Copy link
Member

Oh, @dnephin forgot that you wanted to copy it to the API v1.20 docs 😊 let me know if you want to pick that up or want us to do that for you

@dnephin dnephin deleted the add_digest_to_api_docs branch October 16, 2015 18:23
@dnephin
Copy link
Member Author

dnephin commented Oct 16, 2015

I'm not entirely sure how far back it needs to ported, it's probably not entirely necessary.

@thaJeztah
Copy link
Member

np, we can fix that later (not sure when these changed)

@tiborvass tiborvass removed their assignment Oct 22, 2015
thaJeztah added a commit to thaJeztah/docker that referenced this pull request Nov 3, 2015
Add back the "old" networksettings fields that were removed,
but added back to maintain backward compatibility, in
moby#17538

Update network endpoint responses, with updated response
introduced in;
moby#17536

Added changes to v1.22 that were applied to the v1.21 / v1.20 docs
after the API bump(s);

moby#17085
moby#17127
moby#13707

Also fixed some mixed tab/spaces indentation
and Markdown formatting issues (causing code-blocks to
be rendered incorrectly)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
tiborvass pushed a commit to tiborvass/docker that referenced this pull request Nov 3, 2015
Add back the "old" networksettings fields that were removed,
but added back to maintain backward compatibility, in
moby#17538

Update network endpoint responses, with updated response
introduced in;
moby#17536

Added changes to v1.22 that were applied to the v1.21 / v1.20 docs
after the API bump(s);

moby#17085
moby#17127
moby#13707

Also fixed some mixed tab/spaces indentation
and Markdown formatting issues (causing code-blocks to
be rendered incorrectly)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 286fe69)

Conflicts:
	docs/reference/api/docker_remote_api_v1.22.md
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.

6 participants