Commit graph

151 commits

Author SHA1 Message Date
Milos Gajdos
279fa01b2a
Small update of API docs
Signed-off-by: Milos Gajdos <milosthegajdos@gmail.com>
2023-08-18 08:47:04 +01:00
Milos Gajdos
7b502560ca
Merge pull request #3801 from iasoon/fix-api-docs-json
Fix json formatting in registry api docs
2023-07-22 19:16:36 +01:00
cui fliter
dedc8fa7cc docs: fix typo
Signed-off-by: cui fliter <imcusg@gmail.com>
2023-07-10 16:18:15 +08:00
Irene Diez
93010cae90 docs/specs/api: fix Content-Type typo
Signed-off-by: Irene Diez <idiez@redhat.com>
2023-06-08 10:59:34 +02:00
Milos Gajdos
9b629737cb
Merge pull request #3804 from thaJeztah/deprecate_schema1
manifest/schema1: mark docker manifest v2, schema 1 deprecated
2023-01-30 16:16:38 +00:00
Sebastiaan van Stijn
86cd830fb3
Descriptor: align field order with OCI image specification
I am looking at aligning the types defined in this repository with the
OCI image specification, and potentially exchanging local types with
those from the specification.

This patch is a stepping-stone towards that effort, but as this changes
the format of the serialized JSON, I wanted to put this up first before
proceeding with the other work in case there are concerns.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-11-29 23:24:10 +01:00
Sebastiaan van Stijn
ff2bce2731
manifest/schema1: mark docker manifest v2, schema 1 deprecated
Docker Image manifest v2, schema version 1 is deprecated since 2015, when
manifest v2, schema version 2 was introduced (2e3f4934a7).

Users should no longer use this specification other than for backward
compatibility.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-11-26 13:21:06 +01:00
Ilion Beyst
89384541cc Fix json formatting in registry api docs
Signed-off-by: Ilion Beyst <ilion.beyst@gmail.com>
2022-11-24 23:21:18 +01:00
Milos Gajdos
ad6249fa92
Merge pull request #3681 from Jamstah/api-doc-fix
Fix API doc parameter placeholder: last
2022-11-07 15:34:07 +00:00
Littlemoon917
e24be4e834 fix all json syntax error
Signed-off-by: Littlemoon917 <Littlemoon917@users.noreply.github.com>
2022-09-02 16:40:01 +08:00
James Hewitt
9e74396f31
Fix API doc parameter placeholder: last
Last is not an integer, but is the last returned value to start the
pagination from.

Signed-off-by: James Hewitt <james.hewitt@uk.ibm.com>
2022-07-07 12:17:10 +01:00
iasoon
8628eab487 fix json syntax error in error api spec
Signed-off-by: Ilion Beyst <ilion.beyst@gmail.com>
2022-06-12 12:29:45 +02:00
Milos Gajdos
5fe693474e
Merge pull request #2291 from lucab/ups/spec-fixes
docs/spec: provide valid manifest examples
2022-04-22 18:01:03 +01:00
Wang Yan
9332c3cc7b
Merge pull request #3498 from hasheddan/md-links-oauth
(docs) Fix rendering of markdown links in OAuth docs HTML
2022-04-23 00:33:20 +08:00
Sebastiaan van Stijn
3b83bce74d
docs: update some URLs and remove some of the Docker branding
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-01-19 10:39:26 +01:00
hasheddan
dea56fae96
(docs) Fix rendering of markdown links in OAuth docs HTML
Fixes link rendering in HTML portion of the OAuth docs by converting
them to anchor tags.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2021-09-14 08:52:19 -04:00
Justin Cormack
1660df4b60
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>
2021-08-20 12:14:42 +01:00
Brandon Mitchell
9c7967a32d Update PUT and PATCH APIs
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2021-06-29 14:16:33 -04:00
Brandon Mitchell
3f09e31ea6 Fixing http status for PUT/PATCH APIs
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2021-06-28 15:23:04 -04:00
Wang Yan
263da70ea6
Merge pull request #3410 from khaosdoctor/patch-1
Fix html not rendering markdown link properly
2021-06-27 17:44:10 +08:00
João Pereira
6d75bd043a
Merge pull request #3425 from lostsquirrel/patch-1
Fix the /v2/_catalog n parameter description
2021-06-17 11:10:14 +01:00
lostsquirrel
6d9a3aba04 fix the /v2/_catalog n parameter description
If `n` is not present only 100 entries returned

Signed-off-by: lisong <lisong@cdsunrise.net>
2021-06-17 17:33:55 +08:00
João Pereira
5641309112
Update API spec
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-06-15 15:24:32 +01:00
João Pereira
1398d3b5c6
Remove unrelated spec update
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-05-28 10:12:01 +01:00
João Pereira
6ae6df7d75
Add tag delete API
Signed-off-by: João Pereira <484633+joaodrp@users.noreply.github.com>
2021-05-27 23:27:02 +01:00
Lucas Santos
fefc0e2b24
Fix html not rendering markdown link properly
Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
2021-05-04 13:04:56 -03:00
eyjhb
9cf39997af
added pagination error to api docs
Signed-off-by: eyjhb <eyjhbb@gmail.com>
2021-04-23 18:06:04 +02:00
Wang Yan
89337b7a25
Merge pull request #3371 from AkihiroSuda/remove-wrong-arm
docs/spec/manifest-v2-2.md: fix ARM variant
2021-03-04 10:57:22 +08:00
Akihiro Suda
c432849e44
docs/spec/manifest-v2-2.md: fix ARM variant
The correct `vairant` string for ARM v6 is "v6", not "armv6l".

There is no known implementation that actually uses "armv6l".

See the discussion in opencontainers/image-spec PR 817

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2021-02-25 17:51:26 +09:00
Sebastiaan van Stijn
1d33874951
go.mod: change imports to github.com/distribution/distribution/v3
Go 1.13 and up enforce import paths to be versioned if a project
contains a go.mod and has released v2 or up.

The current v2.x branches (and releases) do not yet have a go.mod,
and therefore are still allowed to be imported with a non-versioned
import path (go modules add a `+incompatible` annotation in that case).

However, now that this project has a `go.mod` file, incompatible
import paths will not be accepted by go modules, and attempting
to use code from this repository will fail.

This patch uses `v3` for the import-paths (not `v2`), because changing
import paths itself is a breaking change, which means that  the
next release should increment the "major" version to comply with
SemVer (as go modules dictate).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-08 18:30:46 +01:00
Patrick Easters
639de6a02f Fix typo for digest regexp
Signed-off-by: Patrick Easters <peasters@redhat.com>
2021-02-05 14:52:27 -05:00
Sebastiaan van Stijn
7728c5e445
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>
2020-07-08 12:18:31 +02:00
Adrian Plata
07a50201c9 Adding deprecated schema instructions
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-03 11:44:28 -07:00
Luca Bruno
15b0204758
registry: fix binary JSON content-type
This fixes registry endpoints to return the proper `application/json`
content-type for JSON content, also updating spec examples for that.

As per IETF specification and IANA registry [0], the `application/json`
type is a binary media, so the content-type label does not need any
text-charset selector. Additionally, the media type definition
explicitly states that it has no required nor optional parameters,
which makes the current registry headers non-compliant.

[0]: https://www.iana.org/assignments/media-types/application/json

Signed-off-by: Luca Bruno <lucab@debian.org>
2019-01-14 09:04:42 +00: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
Luca Bruno
119a48eb79
docs/spec: provide a valid manifest-v2-s1 example
Signed-off-by: Luca Bruno <luca.bruno@coreos.com>
2017-05-30 14:32:58 +00:00
Luca Bruno
3244e471de
docs/spec: provide a valid manifest-list-v2-s2 example
Signed-off-by: Luca Bruno <luca.bruno@coreos.com>
2017-05-30 14:32:32 +00: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