Skip to content

docs: add AI Governance Audit Logs API - #25931

Open
brefsdal wants to merge 4 commits into
docker:mainfrom
brefsdal:brian/ai-governance-audit-logs-api-docs
Open

brefsdal wants to merge 4 commits into
docker:mainfrom
brefsdal:brian/ai-governance-audit-logs-api-docs

Conversation

@brefsdal

@brefsdal brefsdal commented Aug 25, 2026 •

Copy link
Copy Markdown

Description

Adds public documentation for GET /v2/auditlogs/governance/{org_name} and aligns the guide and OpenAPI reference with merged data-platform main (66bc70971), including docker/data-platform#2711 and docker/data-platform#2712.

  • Documents raw Organization Access Token authentication and the View audit logs permission.
  • Covers the 25-event default, 100-event page cap, 30-day request window, and cursor-preserved time bounds. Text search can use the default window.
  • Documents the API and gateway organization limits of 5 requests per second and the gateway limit of 600 requests per minute per source IP. Clients and tokens share the organization limits, and each pagination request counts.
  • Updates the structured application 429 example to limit: 5, window_seconds: 1, and retry_after_seconds: 1.
  • Keeps Retry-After optional: application responses include it when the reset time is known, while gateway responses can omit it and use a different body. The chart-owned Lua policy was removed in docker/data-platform#2725; these docs do not promise gateway header translation.
  • Covers request deadlines, search timeouts, and retryable dependency failures, with links to the audit record reference and subscription/access-token pages.

Release status

The production route and gateway policies are enabled in the merged configuration. One unauthenticated GET to https://api.docker.com/v2/auditlogs/governance/vonwig?page_size=1 returned HTTP 401 with {"error":"missing or malformed Authorization header"}, confirming public routing and missing-token rejection.

Before publishing, confirm the OAT View audit logs permission is available in Docker Home and record authorized production query/pagination, organization/IP throttling, retry behavior, and monitoring validation. No authenticated request or rate-limit load test was performed in this update. Merged configuration and a 401 response do not establish those outcomes.

Validation

  • Scoped rumdl and Vale checks: passed with 0 errors, warnings, or suggestions.
  • Prettier check for the OpenAPI YAML: passed.
  • OpenAPI 3.0 validation: passed using @apidevtools/swagger-parser 10.1.0.
  • Public server and application 429 example checked against the merged production values.
  • git diff --check: passed.
  • Full Hugo rendering and rendered link validation were not run; PR CI and the deploy preview still need review.

@netlify

netlify Bot commented Aug 25, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 2725e6a
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6adaabea87744aabf396a525
😎 Deploy Preview https://deploy-preview-25931--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 area/api Relates to Docker API docs area/ai labels Aug 25, 2026
@brefsdal
brefsdal marked this pull request as ready for review October 6, 2026 18:40
The guide omitted the released production limits and the OpenAPI example used the earlier application quota. Document both organization limiters at 5 requests per second, the gateway IP quota, and a matching application rate-limit response.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ai area/api Relates to Docker API docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant