Skip to content

Conversation

@jarqvi
Copy link
Contributor

@jarqvi jarqvi commented Jan 6, 2026

Description

Corrected API documentation URLs that were pointing to incorrect locations.

Related issues or tickets

Reviews

  • Technical review
  • Editorial review
  • Product review

@netlify
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for docsdocker failed. Why did it fail? →

Name Link
🔨 Latest commit e42100b
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/695e4ea39cb3d4000888a024

@github-actions github-actions bot added area/extensions Relates to Docker Extensions area/api Relates to Docker API docs labels Jan 6, 2026
@jarqvi jarqvi force-pushed the fix/api-docs-links branch from 5a64337 to 1596996 Compare January 6, 2026 11:09
Signed-off-by: MohammadHasan Akbari <[email protected]>
@thaJeztah
Copy link
Member

Updating LGTM, but wondering; did some redirect break? It looks like this URL was valid before 🤔

@thaJeztah thaJeztah requested a review from dvdksn January 6, 2026 11:35
@jarqvi
Copy link
Contributor Author

jarqvi commented Jan 6, 2026

Updating LGTM, but wondering; did some redirect break? It looks like this URL was valid before 🤔

It seems that the API documentation for some versions is no longer available:
https://docs.docker.com/reference/api/engine/#api-version-matrix

@thaJeztah
Copy link
Member

Oh! You're right, it's probably because it was linking to a deprecated API version. We should probably add a redirect for those as well, and link to the overview (or redirect to "latests") 🤔. That can definitely be done as a follow up though

@dvdksn any thoughts?

@thaJeztah
Copy link
Member

@gtardif is any of this content generated? (if so, should these links be updated in a source repository somewhere?)

@dvdksn
Copy link
Contributor

dvdksn commented Jan 7, 2026

@thaJeztah hmm yeah we should have redirects for these now-removed pages. I think these slipped through our link checker because they're ignored:

- "^/reference/api/engine/v.+/#.*$"

And the reason they're ignored, iirc, is because we can't check these links without javacript, since they're resolved by redoc.

Opened #23938

@jarqvi
Copy link
Contributor Author

jarqvi commented Jan 7, 2026

I have applied the requested changes.

@thaJeztah
@dvdksn

Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thaJeztah
Copy link
Member

Looks like netlify is hitting GitHub API rate limits 🤔

1:16:44 PM: mise [email protected] install
1:16:44 PM: mise WARN  GitHub rate limit exceeded. Resets at 2026-01-07 13:09:12 +00:00
1:16:44 PM: mise WARN  GitHub rate limit exceeded. Resets at 2026-01-07 13:09:12 +00:00
1:16:44 PM: mise WARN  GitHub rate limit exceeded. Resets at 2026-01-07 13:09:12 +00:00
1:16:44 PM: mise ERROR Failed to install aqua:gohugoio/hugo/[email protected]: HTTP status client error (403 rate limit exceeded) for url (https://api.github.com/repos/gohugoio/hugo/releases/tags/0.154.2): HTTP status client error (403 rate limit exceeded) for url (https://api.github.com/repos/gohugoio/hugo/releases/tags/v0.154.2)
1:16:44 PM: mise ERROR Run with --verbose or MISE_VERBOSE=1 for more information
1:16:44 PM: Error during Hugo 0.154.2 install

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes LGTM though, thanks!

@dvdksn dvdksn merged commit a5938bb into docker:main Jan 7, 2026
11 of 15 checks passed
@jarqvi jarqvi deleted the fix/api-docs-links branch January 7, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/api Relates to Docker API docs area/extensions Relates to Docker Extensions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants