-
Notifications
You must be signed in to change notification settings - Fork 7.7k
registry: add reference #22497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
registry: add reference #22497
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
77e8a7e
to
410cb85
Compare
content/reference/drivers-and-specifications/token-authorization/token.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
before I do a more thorough review, I left a comment about why we are not using an OpenAPI spec to generate the documentation here
Updated Registry API Documentation
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a bunch of inline comments, but overall:
- For every endpoint, ideally we would have: Request syntax (covered this well) and a valid response example (we are missing these)
- Some of the steps feel like they are out of order. Maybe this is my misunderstanding of how to use the Registry API, but I left some comments about checking if layers/images exist coming before the rest of the steps.
- Lots of gerunds in headings make it hard to skim/find action oriented phrases, I would suggest changing the headings to remove gerunds so I can skim the content and look for actions I want to execute
- Lots of headings don't appear on the right TOC which makes it hard to skim and find what I am looking for. Ideally I would see the entire API in the TOC so I can jump to the endpoint I want
A good example format for endpoint patterns might be something like (this keeps it easy to skim and get all the info I need per endpoint):
Get image manifest
GET /v2//manifests/
Required headers:
- Accept: example
- Authorization: Bearer
Success response:
example of request response `200 OK` w/ Content-type
Possible errors:
401
404
Happy to help restructure this if you want me to overhaul the endpoint sections for you to commit changes @craig-osterhout
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
Did a complete overhaul of the pre-existing main content, migrated it to OpenAPI spec, and tested it. |
@craig-osterhout if is blocking and technically correct, I can approve - editorial stuff will get addressed in the API reference project so we can tackle that in follow ups |
Description
Re-add registry reference from point in time of deletion at #18390, not upstream.
https://deploy-preview-22497--docsdocker.netlify.app/reference/api/registry/latest/
https://deploy-preview-22497--docsdocker.netlify.app/reference/api/registry/auth/
Related issues or tickets
ENGDOCS-2577
Reviews