TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions
2730 commits 2 branches 61 tags 129 MiB
Commit graph

118 commits

Author SHA1 Message Date
Justin Cormack
19b573a6f7
Change should to must in v2 spec 
We found some examples of manifests with URLs specififed that did
not provide a digest or size. This breaks the security model by allowing
the content to change, as it no longer provides a Merkle tree. This
was not intended, so explicitly disallow by tightening wording.

Signed-off-by: Justin Cormack <justin.cormack@docker.com>
(cherry picked from commit 1660df4b60)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-08 15:24:07 +02:00
Sebastiaan van Stijn
48eeac88e9
docs: add redirect for old URL 
Looks like there's some projects refering to this old URL:
https://grep.app/search?q=https%3A//docs.docker.com/reference/api/registry_api/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 7728c5e445)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-07-08 12:22:22 +02:00
Adrian Plata
a3c027e626
Adding deprecated schema instructions 
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
(cherry picked from commit 07a50201c9)
Signed-off-by: Derek McGowan <derek@mcgstyle.net>
 2019-09-03 11:56:53 -07:00
ruicao
d1f36d46c9 Fix some typos 
Signed-off-by: ruicao <ruicao@alauda.io>
 2018-09-07 18:13:53 +08:00
Misty Stanley-Jones
a4c32bce50 Fixed broken storage driver link 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2018-01-25 14:54:50 -08:00
Per Lundberg
aac2f6c8b7 api.md: Fixed incorrect grammar 
I noted this while reading at https://docs.docker.com/registry/spec/api/

Signed-off-by: Per Lundberg <perlun@gmail.com>
 2018-01-02 12:49:31 +02:00
Misty Stanley-Jones
fda42e5ef9 Fix keyword format for downstream docs 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-10-24 15:26:28 -07:00
Jon Johnson
3d7803ec8c Fix typo in api spec 
Signed-off-by: Jon Johnson <jonjohnson@google.com>
 2017-07-28 10:13:32 -07:00
Stephen Day
cb851f6598 Merge pull request #2345 from mstanleyjones/put-back-image 
Put back v2-registry-auth.png
 2017-07-24 15:01:48 -07:00
Misty Stanley-Jones
1d95716792 Put back v2-registry-auth.png 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-07-24 14:27:16 -07:00
Stephen J Day
5e5156afa3
api: url typo in specification 
Signed-off-by: Stephen J Day <stephen.day@docker.com>
 2017-07-18 14:48:55 -07:00
Ina Panova
5ccd03d28a Fixing image manifest schema2 medaitype typo in docs. 
Signed-off-by: Ina Panova <ipanova@redhat.com>
 2017-06-23 12:25:52 +02:00
Misty Stanley-Jones
8e703afdc6 Fix doubled words 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2016-11-28 11:29:11 -08:00
Derek McGowan
8d096a4f42 Merge pull request #1969 from TrumanLing/master 
api.md:fix disordered placement of section "Deleting a Layer"
 2016-11-23 13:59:17 -08:00
Derek McGowan
e10634f8c3
Update scope specification for resource class 
Update grammar to support a resource class. Add
example for plugin repository class.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-11-21 13:32:12 -08:00
Victor Vieux
b82a2efc33 switch to v1 and remove .image 
Signed-off-by: Victor Vieux <vieux@docker.com>
 2016-11-10 11:39:15 -08:00
LingFaKe
0c42a73b70 api.md/api.md.tmpl:format wrong style of section "Deleting a Layer" 
Signed-off-by: Ling FaKe <lingfake@huawei.com>
 2016-10-19 09:07:13 +08:00
Derek McGowan
4dd19db95b Merge pull request #2007 from qar/fix/docs 
Fix documentation typo
 2016-10-17 11:40:35 -07:00
Qiao Anran
3d703a0b82
Fix documentation typo 
Signed-off-by: Qiao Anran <qiaoanran@gmail.com>
 2016-10-17 14:58:29 +08:00
Misty Stanley-Jones
f180e9a934 Convert Markdown frontmatter to YAML 
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2016-10-14 15:59:19 -07:00
Derek McGowan
f193270c89
Add note about implementation of oauth2 
Reading the oauth2 token documentation is misleading as it makes
no mention of it being a newer feature which may not be supported
by the token server. Add a note mentioning if it is not supported
to refer to the token documentation for getting a token.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-09-26 15:39:00 -07:00
Stephen J Day
6bcdb38b92
spec/manifest: clarify relationship between urls and foreign layers 
Previously, the specificiation incorrectly bound the fates of `urls` and
foreign layers. These are complementary but unrelated features, in that
the `urls` field may be populated for layers that aren't foreign. The
type of the layer only dictates the push behavior of the layer, rather
than involving where it came from.

For example, one may pull a foreign layer from a registry, but they may
not push it back to another registry. Conversely, a layer that has no
restrictions on push/pull behavior may be fetched via `urls` entries.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
 2016-08-29 18:34:55 -07:00
Randy Barlow
63b2e74b46
Fix an erroneous comma in documentation JSON. 
Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
 2016-08-23 13:39:24 -04:00
Aaron Lehmann
b0099004e2 Document TOOMANYREQUESTS error code 
Add entries with this error code in registry/api/v2/descriptors.go.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
 2016-07-12 12:18:54 -06:00
Sven Dowideit
82bdab7d48 Replace google docs image link with one in this repo 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
 2016-06-22 13:08:56 +00:00
Richard Scothern
352924cd85 Clarify API documentation around catalog fetch behavior 
Signed-off-by: Richard Scothern <richard.scothern@docker.com>
 2016-06-08 10:39:17 -07:00
allencloud
db90724ab0 fix typos 
Signed-off-by: allencloud <allen.sun@daocloud.io>
 2016-06-02 23:03:27 +08:00
Sven Dowideit
e4acec1806 Next load of docs validation fixes 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
 2016-06-01 18:18:17 +00:00
Sven Dowideit
3069a04b8c Make the index.html files the visible overview menu entry 
And move menu entry definition into a page that the user has no reason to navigate to

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
 2016-05-28 01:02:40 +00:00
Derek McGowan
3207e0c112 Update auth documentation examples to show "expires in" as int 
Go will fail to parse the examples since an int is expected rather than a string for the "expires in" value

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-05-25 11:43:36 -07:00
Ke Xu
79d6008a54 fix broken markdown 
Signed-off-by: Ke Xu <leonhartx.k@gmail.com>
 2016-05-24 16:33:30 +09:00
John Starks
f0052b8434 Add support for layers from foreign sources 
This will be used to support downloading Windows base layers from
Microsoft URLs.

Signed-off-by: John Starks <jostarks@microsoft.com>
 2016-05-20 12:31:10 -07:00
cyli
8854eed7ab Update the auth spec scope grammar to reflect the fact that hostnames are optionally supported. 
Signed-off-by: cyli <cyli@twistedmatrix.com>
 2016-05-11 15:19:50 -07:00
Richard Scothern
2a4deee441 Remove the unimplemented monolithic upload section from the API documentation. 
Signed-off-by: Richard Scothern <richard.scothern@docker.com>
 2016-05-04 15:58:08 -07:00
Fabio Huser
17756eb43e Clarify kid format for JWT token auth in docs 
The kid value can have an arbitrary format according JOSE specification, but Docker distribution expects a specific format (libtrust fingerprint) to work. This is not written in the documentation so far and is only mentioned in the libtrust source code itself.

Signed-off-by: Fabio Huser <fabio@fh1.ch>
 2016-04-17 12:04:15 +02:00
Mary Anthony
6bce49d51d Updated per conversation with Richard 
Removing draft
Richard's comments and some fixes

Signed-off-by: Mary Anthony <mary@docker.com>
 2016-04-13 06:43:11 -07:00
Phil Estes
bf9f80eaff Correct examples and architecture references in v2.2 spec 
Add link to the official list of $GOOS and $GOARCH values and correct
values that were incorrectly listed in the spec examples.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
 2016-04-03 17:50:22 -04:00
Aaron Lehmann
a11f6b6cfd Merge pull request #1418 from dmcgowan/oauth-spec 
Add specification for using OAuth with the token server
 2016-03-31 10:42:12 -07:00
Richard Scothern
9b5caf64cf Add a note to the delete manifest section to aid getting the correct 
digest to delete manifests.

Signed-off-by: Richard Scothern <richard.scothern@docker.com>
 2016-03-30 10:59:26 -07:00
Richard Scothern
b787035d8b Merge pull request #1545 from jonjohnsonjr/typos 
Fix typos in docs/spec/api.md
 2016-03-23 16:41:44 -07:00
Jon Johnson
f64981b472 Fix typos in docs/spec/api.md 
Fix grammatical and formatting issues.
Add links to sections or other documents where appropriate.

Signed-off-by: Jon Johnson <jonjohnson@google.com>
 2016-03-18 15:01:20 -07:00
John Starks
5b0a484739 Add os.version and os.features to platform spec 
These changes are needed to differentiate Windows images.

Signed-off-by: John Starks <jostarks@microsoft.com>
 2016-03-17 16:54:21 -07:00
Derek McGowan
093fbdbfc4 Add client_id to get token endpoint 
Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-03-09 12:35:20 -08:00
Derek McGowan
66d6eaa83f Update scope list to use space separator 
The oauth spec defines using a space to separate parts of a scope.
To better comply with future implementations built on oauth use a space to separate the resource scopes.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-03-03 17:44:09 -08:00
Derek McGowan
d51f76f903 Update oauth documentation to include returned scope 
Add post response values
Update password grant type to match oauth spec

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-03-03 17:44:09 -08:00
Richard Scothern
c8dff1bb57 Merge pull request #1364 from aaronlehmann/content-type-in-api-docs 
Add information about manifest content types to API spec
 2016-03-01 13:53:49 -08:00
Stefan Weil
615c6dfced Fix some typos in comments and strings 
All of them were found and fixed by codespell.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
 2016-02-23 22:33:38 +01:00
Derek McGowan
3fc4e4cdc8 Add resource scope list definition 
Allow providing multiple scopes in a single scope string

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-02-12 16:07:21 -08:00
Derek McGowan
6d6c37c06a Update client section 
Use client_id as defined in oauth rfc instead of custom client field

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-02-11 13:57:23 -08:00
Derek McGowan
32931689d5 Add scope documentation 
Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
 2016-02-11 13:57:23 -08:00