mirror of
https://github.com/docker/docs.git
synced 2026-11-04 18:26:54 +00:00
Brian Refsdal
171f597d4e
## 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](https://github.com/docker/data-platform/pull/2711)
and
[docker/data-platform#2712](https://github.com/docker/data-platform/pull/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](https://github.com/docker/data-platform/pull/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.
77 lines
2.3 KiB
JSON
77 lines
2.3 KiB
JSON
{
|
|
"apis": [
|
|
{
|
|
"id": "hub",
|
|
"product": "hub",
|
|
"title": "Docker Hub",
|
|
"source": "content/reference/api/hub/latest.yaml",
|
|
"owner": "docker/docs",
|
|
"manual": "/manuals/docker-hub/",
|
|
"connection": "hosted",
|
|
"guides": ["/manuals/security/provisioning/scim/provision-scim.md"]
|
|
},
|
|
{
|
|
"id": "dvp",
|
|
"product": "dvp",
|
|
"title": "Publisher analytics",
|
|
"source": "content/reference/api/dvp/latest.yaml",
|
|
"owner": "docker/docs",
|
|
"manual": "/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md",
|
|
"connection": "hosted",
|
|
"guides": []
|
|
},
|
|
{
|
|
"id": "registry",
|
|
"product": "registry",
|
|
"title": "Registry",
|
|
"source": "content/reference/api/registry/latest.yaml",
|
|
"owner": "docker/docs",
|
|
"manual": "/manuals/docker-hub/repos/",
|
|
"connection": "hosted",
|
|
"guides": ["/reference/api/registry/auth.md"]
|
|
},
|
|
{
|
|
"id": "ai-governance",
|
|
"product": "ai-governance",
|
|
"title": "AI Governance",
|
|
"source": "content/reference/api/ai-governance/api.yaml",
|
|
"owner": "docker/governor-services",
|
|
"manual": "/manuals/ai/sandboxes/governance/",
|
|
"connection": "hosted",
|
|
"guides": []
|
|
},
|
|
{
|
|
"id": "ai-governance-audit-logs",
|
|
"product": "ai-governance",
|
|
"title": "AI Governance Audit Logs",
|
|
"source": "content/reference/api/ai-governance-audit-logs/api.yaml",
|
|
"owner": "docker/docs",
|
|
"manual": "/manuals/ai/sandboxes/governance/audit/",
|
|
"connection": "hosted",
|
|
"guides": ["/manuals/ai/sandboxes/governance/audit/api.md"]
|
|
},
|
|
{
|
|
"id": "sandboxes",
|
|
"product": "sandboxes",
|
|
"title": "Docker Sandboxes",
|
|
"source": "content/reference/api/sandboxes/api.yaml",
|
|
"owner": "docker/sbx-api",
|
|
"manual": "/manuals/ai/sandboxes-api/",
|
|
"connection": "hosted",
|
|
"experimental": true,
|
|
"guides": [
|
|
"/manuals/ai/sandboxes-api/authentication.md",
|
|
"/manuals/ai/sandboxes-api/get-started.md"
|
|
]
|
|
}
|
|
],
|
|
"legacyAPIs": [
|
|
{
|
|
"title": "Docker Engine",
|
|
"url": "/reference/api/engine/",
|
|
"connection": "unix",
|
|
"description": "Manage containers, images, networks, and volumes."
|
|
}
|
|
]
|
|
}
|