Skip to content

docs(oat): document Hub API endpoint OAT support for repos-new - #25835

Open
vdamery wants to merge 3 commits into
docker:mainfrom
vdamery:docs/oat-hub-api-support
Open

docs(oat): document Hub API endpoint OAT support for repos-new#25835
vdamery wants to merge 3 commits into
docker:mainfrom
vdamery:docs/oat-hub-api-support

Conversation

@vdamery

@vdamery vdamery commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents which Docker Hub API endpoints accept org access token (OAT) authentication, and the scope-dependent listing behavior for repository listing.

Changes

  • content/reference/api/hub/latest.yaml: Added <span class="oat"></span> markers to 11 repository endpoint groups under /v2/namespaces/{namespace}/repositories/. Includes a note on scope-based listing behavior for GET /v2/namespaces/{namespace}/repositories.
  • content/manuals/enterprise/security/access-tokens.md: New "Hub API support" section covering supported endpoint categories and the scope-repository-list listing behavior.

OAT listing behavior

GET /v2/namespaces/{namespace}/repositories:

  • OAT with scope-repository-list → returns all repos including private
  • OAT without that scope → returns only public repos

Test plan

  • Preview site renders <span class="oat"> badge on repo endpoints
  • Hub API support section appears correctly in access-tokens manual page
  • Listing behavior note is clear and accurate

@netlify

netlify Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 4302f74
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a7f3d0d06e8df0008d73a09
😎 Deploy Preview https://deploy-preview-25835--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 area/api Relates to Docker API docs label Aug 14, 2026
@vdamery
vdamery force-pushed the docs/oat-hub-api-support branch from 9358dbb to 3d226c4 Compare August 14, 2026 15:42
Adds <span class="oat"></span> labels to all repository-related
endpoints that accept org access tokens via the AllowOAT() middleware:

- GET/POST /v2/namespaces/{namespace}/repositories
- GET/HEAD /v2/namespaces/{namespace}/repositories/{repository}
- GET/HEAD /v2/namespaces/{namespace}/repositories/{repository}/tags
- GET/HEAD /v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}
- PATCH/POST /v2/namespaces/{namespace}/repositories/{repository}/immutabletags
- POST /v2/repositories/{namespace}/{repository}/groups

Also documents the OAT-specific listing behavior on GET repositories:
an OAT with scope-repository-list sees all repos including private;
without it, only public repos are returned.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vdamery
vdamery force-pushed the docs/oat-hub-api-support branch from 3d226c4 to 71716c8 Compare August 14, 2026 15:58
Add a Hub API support section to the OAT manual page explaining:
- Which endpoint categories accept OAT authentication
- The scope-based listing behavior on GET /v2/namespaces/{ns}/repositories
  (scope-repository-list → all repos including private; else public-only)
- Endpoints that do not support OAT (manifests, collaborators, settings)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vdamery
vdamery force-pushed the docs/oat-hub-api-support branch from 71716c8 to 4d4abfd Compare August 14, 2026 16:01
Add a new "Available scopes" section documenting all repository-level
and organization-level OAT scopes with their descriptions and scope
hierarchy (which higher scopes include lower ones).

Update the "Create an organization access token" section to reference
the full scope list and include the new org-level scopes
(scope-repository-list, scope-repository-create,
scope-registry-usage-read) in the organization permissions step.
@vdamery
vdamery marked this pull request as ready for review August 14, 2026 16:38
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant