Skip to content

Commit

Permalink
Tier 1 freshness for Hub API docs (#18687)
Browse files Browse the repository at this point in the history
* update api latest

* fix spacing
  • Loading branch information
stephaurelio authored Nov 17, 2023
1 parent c523c10 commit 2da4340
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions content/docker-hub/api/latest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@ tags:
The `X-Retry-After` header is a unix timestamp of when you can call the API again.
*Note: These rate limits are separate from anti-abuse and Docker Hub
**Note**: These rate limits are separate from anti-abuse and Docker Hub
download, or pull rate limiting. To learn more about Docker Hub pull rate
limiting, see [Docker Hub download rate limit](https://docs.docker.com/docker-hub/download-rate-limit/).*
limiting, see [Docker Hub download rate limit](https://docs.docker.com/docker-hub/download-rate-limit/).
- name: authentication
x-displayName: Authentication
description: |
Most Docker Hub API endpoints require you to authenticate using your
Docker credentials before using them.
Additionally, similar to the Docker Hub UI features, API endpoint responses may vary depending
on your plan (Free, Pro, or Team) and your account's permissions.
on your plan (Personal, Pro, or Team) and your account's permissions.
To learn more about the features available in each plan and to upgrade your existing plan, see [Docker Pricing](https://www.docker.com/pricing).
- name: access-tokens
Expand Down Expand Up @@ -86,14 +86,14 @@ tags:
**<span style="color: red;">Deprecated</span>**: Advanced Image
Management is deprecated, and scheduled for removal on December 11th, 2023.
For more information, see [Deprecation of Advanced Image Management](https://github.com/docker/roadmap/issues/534)
For more information, see [Deprecation of Advanced Image Management](https://github.com/docker/roadmap/issues/534).
- name: audit-logs
x-displayName: Audit Logs
description: |
The Audit Logs API endpoints allow you to query audit log events across a
namespace.
For more information, see [Audit Log](https://docs.docker.com/docker-hub/audit-log/)
For more information, see [Audit Log](https://docs.docker.com/docker-hub/audit-log/).
- name: org-settings
x-displayName: Org Settings
description: |
Expand All @@ -102,8 +102,8 @@ tags:
- name: repositories
x-displayName: Repositories
description: |
The repository endpoints allow you to manage your repository's
configuration like description.
The repository endpoints allow you to access your repository's
tags.
- name: scim
x-displayName: SCIM
description: |
Expand Down Expand Up @@ -161,10 +161,10 @@ paths:
post:
tags:
- authentication
summary: Second factor authentication.
summary: Second factor authentication
operationId: PostUsers2FALogin
description: |
When user has 2FA enabled, this is the second call to perform after
When a user has two-factor authentication (2FA) enabled, this is the second call to perform after
`/v2/users/login` call.
Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.
Expand Down Expand Up @@ -559,7 +559,7 @@ paths:
$ref: "#/components/schemas/ErrorResponse"
/v2/auditlogs/{account}:
get:
summary: Returns list of audit log events.
summary: Returns list of audit log events
description: Get audit log events for a given namespace.
operationId: AuditLogs_GetAuditLogs
responses:
Expand Down Expand Up @@ -672,7 +672,7 @@ paths:
- audit-logs
/v2/auditlogs/{account}/actions:
get:
summary: Returns list of audit log actions.
summary: Returns list of audit log actions
description:
Get audit log actions for a namespace to be used as a filter for
querying audit events.
Expand Down Expand Up @@ -989,7 +989,7 @@ paths:
and `count` query parameters to receive paginated results.
**Sorting:**<br>
Sorting lets you to specify the order of returned resources by specifying
Sorting lets you specify the order of returned resources by specifying
a combination of `sortBy` and `sortOrder` query parameters.
The `sortBy` parameter specifies the attribute whose value will be used
Expand Down

0 comments on commit 2da4340

Please sign in to comment.