From 2da43407ace2b19b5bcbd10c7f188ddf8d9f0cdd Mon Sep 17 00:00:00 2001 From: Stephanie Aurelio <133041642+stephaurelio@users.noreply.github.com> Date: Fri, 17 Nov 2023 08:34:04 -0800 Subject: [PATCH] Tier 1 freshness for Hub API docs (#18687) * update api latest * fix spacing --- content/docker-hub/api/latest.yaml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/docker-hub/api/latest.yaml b/content/docker-hub/api/latest.yaml index 5d336580e7..32df6cd4b7 100644 --- a/content/docker-hub/api/latest.yaml +++ b/content/docker-hub/api/latest.yaml @@ -43,11 +43,11 @@ 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: | @@ -55,7 +55,7 @@ tags: 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 @@ -86,14 +86,14 @@ tags: **Deprecated**: 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: | @@ -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: | @@ -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. @@ -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: @@ -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. @@ -989,7 +989,7 @@ paths: and `count` query parameters to receive paginated results. **Sorting:**
- 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