Skip to content

hub: add base url to api paths #22870

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

craig-osterhout
Copy link
Contributor

@craig-osterhout craig-osterhout commented Jun 18, 2025

Description

Display the base url specifically for Hub API and Registry API docs.

Is this enough, or do we also need to write something about it in the description at the top?

image

Related issues or tickets

ENGDOCS-2748

Reviews

  • Editorial review

Copy link

netlify bot commented Jun 18, 2025

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 240f443
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/68531ef1aab3d100081b3a9c
😎 Deploy Preview https://deploy-preview-22870--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the hugo Updates related to hugo label Jun 18, 2025
@thaJeztah
Copy link
Member

Thanks!

Did a quick check if they used the correct URL (especially the registry, as it uses registry-1.docker.io, not hub.docker.com), but looks like it does;

Screenshot 2025-06-18 at 22 52 44

I have not checked all of them though, and perhaps @jcarter3 could help double-check.

Is this enough, or do we also need to write something about it in the description at the top?

I'm somewhat tempted to say that it would still be good to have a page somewhere that outlines the domains; specifically because we've historically not been good at documenting them, and in some case have introduced alternative domains that should not be used / not be considered the canonical domain. Having something at the top for each of these API docs won't hurt either.

I know many users have been confused about the domain to use, as many have assumed that hub.docker.com is the domain to use both for the WebUI and APIs related to Docker Hub (which also has been a cause of issues when they want to block access to docker hub registry 😅)

I don't have the full list of the correct ones though, but perhaps @jcarter3 (or someone else closer to Docker Hub and related services) can assist with that as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hugo Updates related to hugo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants