docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tier 1 freshness for Hub API docs (#18687) 

* update api latest

* fix spacing
This commit is contained in:
Stephanie Aurelio 2023-11-17 08:34:04 -08:00 committed by GitHub
parent c523c10618
commit 2da43407ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
content/docker-hub/api/latest.yaml
View File

@ -43,11 +43,11 @@ tags:
The `X-Retry-After` header is a unix timestamp of when you can call the API again. 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 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 - name: authentication
x-displayName: Authentication x-displayName: Authentication
description: | description: |
@ -55,7 +55,7 @@ tags:
Docker credentials before using them. Docker credentials before using them.
Additionally, similar to the Docker Hub UI features, API endpoint responses may vary depending 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). 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 - name: access-tokens
@ -86,14 +86,14 @@ tags:
**<span style="color: red;">Deprecated</span>**: Advanced Image **<span style="color: red;">Deprecated</span>**: Advanced Image
Management is deprecated, and scheduled for removal on December 11th, 2023. 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 - name: audit-logs
x-displayName: Audit Logs x-displayName: Audit Logs
description: | description: |
The Audit Logs API endpoints allow you to query audit log events across a The Audit Logs API endpoints allow you to query audit log events across a
namespace. 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 - name: org-settings
x-displayName: Org Settings x-displayName: Org Settings
description: | description: |
@ -102,8 +102,8 @@ tags:
- name: repositories - name: repositories
x-displayName: Repositories x-displayName: Repositories
description: | description: |
The repository endpoints allow you to manage your repository's The repository endpoints allow you to access your repository's
configuration like description. tags.
- name: scim - name: scim
x-displayName: SCIM x-displayName: SCIM
description: | description: |
@ -161,10 +161,10 @@ paths:
post: post:
tags: tags:
- authentication - authentication
summary: Second factor authentication. summary: Second factor authentication
operationId: PostUsers2FALogin operationId: PostUsers2FALogin
description: | 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. `/v2/users/login` call.
Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs. 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" $ref: "#/components/schemas/ErrorResponse"
/v2/auditlogs/{account}: /v2/auditlogs/{account}:
get: get:
summary: Returns list of audit log events. summary: Returns list of audit log events
description: Get audit log events for a given namespace. description: Get audit log events for a given namespace.
operationId: AuditLogs_GetAuditLogs operationId: AuditLogs_GetAuditLogs
responses: responses:
@ -672,7 +672,7 @@ paths:
- audit-logs - audit-logs
/v2/auditlogs/{account}/actions: /v2/auditlogs/{account}/actions:
get: get:
summary: Returns list of audit log actions. summary: Returns list of audit log actions
description: description:
Get audit log actions for a namespace to be used as a filter for Get audit log actions for a namespace to be used as a filter for
querying audit events. querying audit events.
@ -989,7 +989,7 @@ paths:
and `count` query parameters to receive paginated results. and `count` query parameters to receive paginated results.
**Sorting:**<br> **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. a combination of `sortBy` and `sortOrder` query parameters.
The `sortBy` parameter specifies the attribute whose value will be used The `sortBy` parameter specifies the attribute whose value will be used