Commit Graph

55 Commits

Author SHA1 Message Date
Marc Capell 0e6bcb7389
Update DVP Data API spec 2023-04-25 18:39:29 +02:00
CrazyMax 61e3cb1ce1
remove absolute links
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-11-05 11:10:32 +01:00
David Karlsson 45f1ad92c4
fixed bad indentation in openapi yaml for dvp (#15904) 2022-10-18 20:59:36 +02:00
Chris Ainsworth-Patrick 406b745fa3
CPUB-406 Include repo-level summary in DVP API doc (#15897)
* CPUB-406 Include repo-level summary in DVP API doc

* remove unintentional change

* updated summary format description

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* pr improvements

Co-authored-by: David Karlsson <david.karlsson@docker.com>
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2022-10-18 11:37:47 +02:00
CrazyMax 9a160204ff
docker-hub: fix link to logo asset
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-27 11:44:19 +02:00
Nick Adcock ffc0eec055 Fix hub api list tags page_size description
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2022-09-20 13:07:58 +01:00
Silvin Lubecki d367df78ba
Fix typo in hub API route 2022-09-12 15:41:55 +02:00
Chris Ainsworth-Patrick 28d93655c8
CPUB-374 Remove documentation of endpoints that are going away (#15590) 2022-09-07 16:57:52 +02:00
CrazyMax cc0fc46783
jekyll(assets): move images to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:49:23 +02:00
Nick Adcock d28ef5e470
Show hostname in hub API examples (#15524)
Signed-off-by: Nick Adcock <nick.adcock@docker.com>

Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2022-08-30 15:10:58 +02:00
Milos Gajdos 7b769cbe79
Fix URL paths in deprecated API replacements 2022-08-30 08:46:41 +01:00
jerae-duffin 586c46bf50
Merge pull request #15489 from silvin-lubecki/update-deprecated-api-links
Update deprecated API links to new Hub API endpoints
2022-08-25 16:08:07 -05:00
Silvin Lubecki 8cf13c805e
Fix dumb link 2022-08-25 19:14:04 +02:00
Silvin Lubecki 6c413cc574
Update deprecated API links to new Hub API endpoints 2022-08-25 19:08:59 +02:00
Silvin Lubecki f930f14d63
Add list tags and get tag endpoints OpenAPI documentation 2022-08-25 18:13:33 +02:00
Silvin Lubecki 0f400bf78b
Fix typo 2022-08-24 11:19:44 +02:00
Silvin Lubecki 2c7770680c
Add deprecation notive for Hub V1 API 2022-08-23 16:29:14 +02:00
Chris Ainsworth-Patrick e3bc35a67e
CPUB-291 Update DVP docs to match new API scheme (#15431)
* CPUB-291 Update DVP docs to match new API scheme

* incorporate docs changes
2022-08-19 20:14:49 +02:00
Chris Ainsworth-Patrick a1cc6ad36d
CPUB-274 DVP Data API doc improvements (#15366)
* CPUB-274 DVP Data API doc improvements

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update docker-hub/api/dvp.yaml

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
Co-authored-by: jerae-duffin <83294991+jerae-duffin@users.noreply.github.com>
2022-08-17 11:53:29 +02:00
Ivan Californias 4bae2ec02c Update descriptions from PR comments 2022-07-28 20:00:31 -05:00
Ivan Californias 5202184cc0 AG-1442: Add SCIM API docs 2022-07-27 20:49:53 -05:00
jerae-duffin a80e60648c
Merge pull request #15160 from chrispatrick/update-dvp-doc
Update DVP OAPI doc
2022-07-20 08:21:01 -05:00
Chris Ainsworth-Patrick faceb4360d Update DVP OAPI doc 2022-07-19 15:49:08 +01:00
Josh Newman f764a6e934 ref: reformat from vscode default formatting 2022-07-18 22:39:26 -06:00
Josh Newman 445770f245 fix: make parameters for all verbs to fix validation 2022-07-18 22:39:08 -06:00
Nick Adcock 50c780847b Removes is_private from UpdateRepo docs
The UpdateRepository endpoint in the Hub API does not have the ability
to set a repository's privacy. This removes mention of the field

Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2022-07-13 15:43:28 +01:00
Josh Newman 47b2522006 ref: remove verbiage about postman team 2022-07-12 12:06:08 -06:00
Josh Newman a8bd5e5b14 fix: change link for postman collection 2022-07-11 12:22:14 -06:00
Chris Ainsworth-Patrick cfd1799ca9 Update DVP OAPI doc to latest version 2022-07-05 10:55:53 +01:00
Chris Ainsworth-Patrick 9eb2a8ab72 Update HUB API docs to OpenApi 3 2022-06-06 09:19:38 +01:00
Chris Ainsworth-Patrick 97ef6c0d0e Add separate DVP Data API docs in OpenAPI 3 2022-06-01 15:52:22 +01:00
CrazyMax 76bb73aa45
docker-hub: remove duplicated api latest page
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-05-18 23:19:04 +02:00
Yves Brissaud 117dfca0fc
add endpoint to edit repository (#14324)
* add endpoint to edit a repository configuration

User can edit:
- description
- full description (readme)
- visibility (public or private)

Also added needed route to be able to login using a 2FA.

Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>

* rename repository tag to repositories

Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>

* improve the examples and 404 on edit repo

Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>
2022-03-09 16:21:48 +00:00
Josh Newman d9f2254d9a
Add resources section and new link to postman collection (#13686)
* feat: Add resources section and new link to postman collection

* chore: make description lower

* chore: change to semi
2021-10-13 15:56:22 +01:00
Josh Newman 7958bc6fbc
Add org settings API docs (#13610)
* feat(docker-hub): Add org settings API docs

* feat(docker-hub): Add href for logo

* fix(docker-hub): Add missing forbidden

* ref(docker-hub): Add business plan settings description
2021-10-04 16:26:52 -05:00
Josh Newman c5b1a6ad00
Add access tokens API documentation (#13174)
* feat(hub-api): Add access tokens API documentation.

Also added improvements including
- improvements to slugs (ids) using standard swagger naming conventions
- rate limiting section
- minor verbiage changes to existing docs for clarity

* chore(hub-api): Update PAT description on scopes

* ref(hub-api): Remove periods

* feat(hub-api): Add suggested note on limits

* ref(hub-api): Improve styling for hub-api docs

* chore(hub-api): Update verbiage

* Update docker-hub/api/latest.yaml

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* chore(hub-api): Update access token verbiage

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-07-20 12:26:43 -05:00
Nick Adcock c2902c2e85 Fix authorization header doc in hub api
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-05-27 11:14:05 +01:00
Usha Mandya 0265785bc9
Merge pull request #12755 from zappy-shu/HUB-5515-list-images-current-tag-filter
Doc currently_tagged filter for image list API
2021-04-27 09:36:02 +01:00
Nick Adcock 1027c43e4d Doc currently_tagged filter for image list API
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-04-27 09:02:03 +01:00
Nick Adcock 1e549f0c5d
Add images/{digest}/tags endpoint doc (#12677)
* Add images/{digest}/tags endpoint doc

Signed-off-by: Nick Adcock <nick.adcock@docker.com>

* Fix images/{digest}/tags description

Signed-off-by: Nick Adcock <nick.adcock@docker.com>

* HUB-5528 make images/tags API paginated

Signed-off-by: Nick Adcock <nick.adcock@docker.com>

* Minor update

* HUB-5528 remove accidental spacing

Signed-off-by: Nick Adcock <nick.adcock@docker.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-04-20 18:49:52 +01:00
Jeff f5ef070776
Add initial docs for Audit Logs (#12554)
* Add docs for Audit Logs

* Update based on PR comments

* Update audit logs terminology

* Fix wording based on PR comments

* Apply suggestions from code review

Co-authored-by: Emilie Franchomme <42777373+FranchommeE@users.noreply.github.com>

Co-authored-by: Emilie Franchomme <42777373+FranchommeE@users.noreply.github.com>
2021-03-29 19:08:51 +01:00
Nick Adcock 35a557d603
Update plan description in Hub API
Co-authored-by: Emilie Franchomme <42777373+FranchommeE@users.noreply.github.com>
2021-03-19 08:53:27 -07:00
Nick Adcock 3ad6befeb1 Fix grammar and fullstops
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-19 14:48:14 +00:00
Nick Adcock 7dcd6644ba Remove pricing details in endpoint descs
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-19 11:40:35 +00:00
Nick Adcock aaff816081 Fix type on hub api doc
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-19 10:42:01 +00:00
Nick Adcock a3ddf6766b update hub api descriptions and path
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-18 09:37:28 +00:00
Nick Adcock 9a3b00146f Limit bulk delete to pro users
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-11 14:08:04 +00:00
Nick Adcock eb804a268d Fix GetNamespacesRepositoriesImagesSummary spelling
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-10 11:30:19 +00:00
Nick Adcock 86fe72f8ba Fix swagger validation errors
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-10 11:25:34 +00:00
Nick Adcock 67d5c72489 Add Hub API overview
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-01 11:22:39 +00:00