Commit Graph

22 Commits

Author SHA1 Message Date
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
Nick Adcock d6bbea181d Fix delete request description
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-01 08:59:38 +00:00
Nick Adcock 3b399881eb Add delete current_tag comment
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-03-01 08:59:01 +00:00
Nick Adcock 7c52027060 Add image delete API doc
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-02-26 13:22:50 +00:00
Nick Adcock 404602f38b Fix logo for Hub API docs
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-02-25 15:48:03 +00:00
Nick Adcock 82ed0e463d Add initial image dashboard API docs
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-02-25 15:29:56 +00:00