From 90ae3c732f1c7a0e3c0d53871df276f21c76c42c Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Tue, 20 Oct 2026 17:56:12 -0700 Subject: [PATCH] chore: fix random things in latest.yaml --- content/reference/api/hub/latest.yaml | 110 +- data/api-reference.json | 1452 +++++++++++++------------ 2 files changed, 754 insertions(+), 808 deletions(-) diff --git a/content/reference/api/hub/latest.yaml b/content/reference/api/hub/latest.yaml index 8a182cd909..b6ba7ddb5c 100644 --- a/content/reference/api/hub/latest.yaml +++ b/content/reference/api/hub/latest.yaml @@ -221,7 +221,7 @@ paths: operationId: PostUsers2FALogin security: [] description: | - When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/users/login` call. + When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/auth/token` call. Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs. @@ -331,18 +331,8 @@ paths: security: - bearerAuth: [] parameters: - - description: Page number to return. - in: query - name: page - schema: - type: number - default: 1 - - description: Number of results per page. - in: query - name: page_size - schema: - type: number - default: 10 + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/page_size" responses: "200": description: OK @@ -871,32 +861,13 @@ paths: schema: type: string format: date-time - - name: page - description: page - specify page number. Page number to get. - in: query - required: false - schema: - type: integer - format: int32 - default: 1 - - name: page_size - description: page_size - specify page size. Number of events to return per page. - in: query - required: false - schema: - type: integer - format: int32 - default: 25 + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/page_size" tags: - audit-logs - /v2/orgs/{name}/settings: + /v2/orgs/{org_name}/settings: parameters: - - in: path - name: name - description: Name of the organization. - required: true - schema: - type: string + - $ref: "#/components/parameters/org_name" get: summary: Get organization settings description: | @@ -967,7 +938,9 @@ paths: "404": $ref: "#/components/responses/NotFound" operationId: putV2OrgsByNameSettings - /v2/orgs/{name}/access-tokens: + /v2/orgs/{org_name}/access-tokens: + parameters: + - $ref: "#/components/parameters/org_name" post: summary: Create access token description: | @@ -1007,18 +980,8 @@ paths: security: - bearerAuth: [] parameters: - - description: Page number to return. - in: query - name: page - schema: - type: number - default: 1 - - description: Number of results per page. - in: query - name: page_size - schema: - type: number - default: 10 + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/page_size" responses: "200": description: OK @@ -1127,18 +1090,8 @@ paths: security: - bearerAuth: [] parameters: - - in: query - name: page - required: false - schema: - type: integer - description: Page number to get. Defaults to 1. - - in: query - name: page_size - required: false - schema: - type: integer - description: Number of items to get per page. Defaults to 10. Max of 100. + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/page_size" responses: "200": $ref: "#/components/responses/list_tags" @@ -1340,23 +1293,8 @@ paths: - bearerAuth: [] - {} parameters: - - in: query - name: page - required: false - schema: - type: integer - minimum: 1 - default: 1 - description: Page number to get. Defaults to 1. - - in: query - name: page_size - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 10 - description: Number of repositories to get per page. Defaults to 10. Max of 100. + - $ref: "#/components/parameters/page" + - $ref: "#/components/parameters/page_size" - in: query name: name required: false @@ -2076,11 +2014,7 @@ paths: - $ref: "#/components/parameters/group_name" - $ref: "#/components/parameters/page" - $ref: "#/components/parameters/page_size" - - in: query - name: search - schema: - type: string - description: Search members by username, full_name or email. + - $ref: "#/components/parameters/search" summary: List members of a group description: | List the members (users) that are in a group. @@ -3468,7 +3402,7 @@ components: - code properties: login_2fa_token: - description: The intermediate 2FA token returned from `/v2/users/login` API. + description: The intermediate 2FA token returned from `/v2/auth/token` API. type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c code: @@ -4904,15 +4838,19 @@ components: page: in: query name: page + required: false description: Page number (starts on 1). schema: type: integer + default: 1 page_size: in: query name: page_size + required: false description: Number of items (rows) per page. schema: type: integer + default: 10 invites: in: query name: invites @@ -4923,8 +4861,8 @@ components: in: query name: search schema: - type: integer - description: Search term. + type: string + description: Search members by username, full_name or email scim_attributes: in: query name: attributes diff --git a/data/api-reference.json b/data/api-reference.json index 0465b1761e..3481547983 100644 --- a/data/api-reference.json +++ b/data/api-reference.json @@ -4,7 +4,7 @@ "connection": "hosted", "description": "Docker Hub is a service provided by Docker for finding and sharing container images with your team.\n\nIt is the world's largest library and community for container images.\n\nIn addition to the [Docker Hub UI](https://docs.docker.com/docker-hub/) and [Docker Hub CLI tool](https://github.com/docker/hub-tool#readme) (currently experimental), Docker provides an API that allows you to interact with Docker Hub.\n\nBrowse through the Docker Hub API documentation to explore the supported endpoints.\n", "diagnostics": [], - "digest": "b4db8f3d9b51ba9fb291b52842e83dfffe0992bf3432325bc5866a1fa4192e58", + "digest": "7c280db399f81e7eaaf40c86b7cdfd9317c819b7589353e3a26e78d6a5a8d373", "exampleCount": 315, "experimental": false, "guides": [ @@ -24,23 +24,25 @@ "method": "GET", "parameters": [ { - "description": "Page number to return.", + "description": "Page number (starts on 1).", "in": "query", "name": "page", "pointer": "/paths/~1v2~1access-tokens/get/parameters/0", + "required": false, "schema": { "default": 1, - "type": "number" + "type": "integer" } }, { - "description": "Number of results per page.", + "description": "Number of items (rows) per page.", "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1access-tokens/get/parameters/1", + "required": false, "schema": { "default": 10, - "type": "number" + "type": "integer" } } ], @@ -51,22 +53,10 @@ "operationId": "getV2AccessTokens", "parameters": [ { - "description": "Page number to return.", - "in": "query", - "name": "page", - "schema": { - "default": 1, - "type": "number" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of results per page.", - "in": "query", - "name": "page_size", - "schema": { - "default": 10, - "type": "number" - } + "$ref": "#/components/parameters/page_size" } ], "responses": { @@ -98,6 +88,14 @@ ] }, "references": [ + { + "ref": "#/components/parameters/page", + "url": null + }, + { + "ref": "#/components/parameters/page_size", + "url": null + }, { "ref": "#/components/responses/BadRequest", "url": null @@ -460,7 +458,7 @@ "deprecated": null, "description": "Returns a personal access token by UUID.", "id": "getV2AccessTokensByUuid", - "line": 393, + "line": 383, "method": "GET", "parameters": [ { @@ -708,7 +706,7 @@ "deprecated": null, "description": "Deletes a personal access token permanently. This cannot be undone.\n", "id": "deleteV2AccessTokensByUuid", - "line": 432, + "line": 422, "method": "DELETE", "parameters": [ { @@ -857,7 +855,7 @@ "deprecated": null, "description": "Updates a personal access token partially. You can either update the token's label or enable/disable it.\n", "id": "patchV2AccessTokensByUuid", - "line": 367, + "line": 357, "method": "PATCH", "parameters": [ { @@ -1082,7 +1080,7 @@ "deprecated": null, "description": "List audit log events for a given namespace.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "AuditLogs_ListAuditLogs", - "line": 756, + "line": 746, "method": "GET", "parameters": [ { @@ -1148,26 +1146,24 @@ } }, { - "description": "page - specify page number. Page number to get.", + "description": "Page number (starts on 1).", "in": "query", "name": "page", "pointer": "/paths/~1v2~1auditlogs~1{account}/get/parameters/6", "required": false, "schema": { "default": 1, - "format": "int32", "type": "integer" } }, { - "description": "page_size - specify page size. Number of events to return per page.", + "description": "Number of items (rows) per page.", "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1auditlogs~1{account}/get/parameters/7", "required": false, "schema": { - "default": 25, - "format": "int32", + "default": 10, "type": "integer" } } @@ -1235,26 +1231,10 @@ } }, { - "description": "page - specify page number. Page number to get.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 1, - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/page" }, { - "description": "page_size - specify page size. Number of events to return per page.", - "in": "query", - "name": "page_size", - "required": false, - "schema": { - "default": 25, - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/page_size" } ], "responses": { @@ -1370,6 +1350,14 @@ ] }, "references": [ + { + "ref": "#/components/parameters/page", + "url": null + }, + { + "ref": "#/components/parameters/page_size", + "url": null + }, { "ref": "#/components/schemas/GetAuditLogsResponse", "url": "/reference/api/hub/latest/schemas/GetAuditLogsResponse/" @@ -1541,7 +1529,7 @@ "deprecated": null, "description": "List audit log actions for a namespace to be used as a filter for querying audit log events.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "AuditLogs_ListAuditActions", - "line": 449, + "line": 439, "method": "GET", "parameters": [ { @@ -2837,7 +2825,7 @@ "deprecated": null, "description": "Create multiple invites by emails or DockerIDs. Only a team owner can create invites.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "postV2InvitesBulk", - "line": 2251, + "line": 2185, "method": "POST", "parameters": [ { @@ -3173,7 +3161,7 @@ "deprecated": null, "description": "Mark the invite as cancelled so it doesn't show up on the list of pending invites\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "deleteV2InvitesById", - "line": 2198, + "line": 2132, "method": "DELETE", "parameters": [ { @@ -3352,7 +3340,7 @@ "deprecated": null, "description": "Resend a pending invite to the user, any org owner can resend an invite\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "patchV2InvitesByIdResend", - "line": 2227, + "line": 2161, "method": "PATCH", "parameters": [ { @@ -3533,7 +3521,7 @@ "deprecated": null, "description": "Returns a list of repositories within the specified namespace (organization or user).\n\nPublic repositories are accessible to everyone, while private repositories require appropriate authentication and permissions.\n\n\n\n**OAT listing behavior**: an OAT with the `scope-repository-list` scope sees all repositories including private ones. An OAT without that scope only sees public repositories. This filtering is silent: the response is a normal `200` with no indication that private repositories were withheld.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "listNamespaceRepositories", - "line": 1325, + "line": 1278, "method": "GET", "parameters": [ { @@ -3547,27 +3535,24 @@ } }, { - "description": "Page number to get. Defaults to 1.", + "description": "Page number (starts on 1).", "in": "query", "name": "page", "pointer": "/paths/~1v2~1namespaces~1{namespace}~1repositories/get/parameters/0", "required": false, "schema": { "default": 1, - "minimum": 1, "type": "integer" } }, { - "description": "Number of repositories to get per page. Defaults to 10. Max of 100.", + "description": "Number of items (rows) per page.", "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1namespaces~1{namespace}~1repositories/get/parameters/1", "required": false, "schema": { "default": 10, - "maximum": 100, - "minimum": 1, "type": "integer" } }, @@ -3607,27 +3592,10 @@ "operationId": "listNamespaceRepositories", "parameters": [ { - "description": "Page number to get. Defaults to 1.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 1, - "minimum": 1, - "type": "integer" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of repositories to get per page. Defaults to 10. Max of 100.", - "in": "query", - "name": "page_size", - "required": false, - "schema": { - "default": 10, - "maximum": 100, - "minimum": 1, - "type": "integer" - } + "$ref": "#/components/parameters/page_size" }, { "description": "Filter repositories by name (partial match).", @@ -3810,6 +3778,14 @@ ] }, "references": [ + { + "ref": "#/components/parameters/page", + "url": null + }, + { + "ref": "#/components/parameters/page_size", + "url": null + }, { "ref": "#/components/responses/forbidden", "url": null @@ -4065,7 +4041,7 @@ "deprecated": null, "description": "Creates a new repository within the specified namespace. The repository will be created\nwith the provided metadata including name, description, and privacy settings.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "CreateRepository", - "line": 1480, + "line": 1418, "method": "POST", "parameters": [ { @@ -4444,7 +4420,7 @@ "deprecated": null, "description": "Returns a repository within the specified namespace (organization or user).\n\nPublic repositories are accessible to everyone, while private repositories require appropriate authentication and permissions.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "GetRepository", - "line": 1556, + "line": 1494, "method": "GET", "parameters": [ { @@ -4753,7 +4729,7 @@ "deprecated": null, "description": "Check a repository within the specified namespace (organization or user).\n\nPublic repositories are accessible to everyone, while private repositories require appropriate authentication and permissions.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "CheckRepository", - "line": 1614, + "line": 1552, "method": "HEAD", "parameters": [ { @@ -4972,7 +4948,7 @@ "deprecated": null, "description": "Updates the immutable tags configuration for this repository.\n\n**Only users with administrative privileges for the repository can modify these settings.**\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "UpdateRepositoryImmutableTags", - "line": 1213, + "line": 1166, "method": "PATCH", "parameters": [ { @@ -5273,7 +5249,7 @@ "deprecated": null, "description": "Validates the immutable tags regex passed in the request body and returns a list of tags matching it in this repository.\n\n**Only users with administrative privileges for the repository can call this endpoint.**\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "VerifyRepositoryImmutableTags", - "line": 1243, + "line": 1196, "method": "POST", "parameters": [ { @@ -5544,7 +5520,7 @@ "deprecated": null, "description": "Returns the list of tags for the specified repository.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "ListRepositoryTags", - "line": 1119, + "line": 1082, "method": "GET", "parameters": [ { @@ -5568,22 +5544,24 @@ } }, { - "description": "Page number to get. Defaults to 1.", + "description": "Page number (starts on 1).", "in": "query", "name": "page", "pointer": "/paths/~1v2~1namespaces~1{namespace}~1repositories~1{repository}~1tags/get/parameters/0", "required": false, "schema": { + "default": 1, "type": "integer" } }, { - "description": "Number of items to get per page. Defaults to 10. Max of 100.", + "description": "Number of items (rows) per page.", "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1namespaces~1{namespace}~1repositories~1{repository}~1tags/get/parameters/1", "required": false, "schema": { + "default": 10, "type": "integer" } } @@ -5595,22 +5573,10 @@ "operationId": "ListRepositoryTags", "parameters": [ { - "description": "Page number to get. Defaults to 1.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of items to get per page. Defaults to 10. Max of 100.", - "in": "query", - "name": "page_size", - "required": false, - "schema": { - "type": "integer" - } + "$ref": "#/components/parameters/page_size" } ], "responses": { @@ -5635,6 +5601,14 @@ ] }, "references": [ + { + "ref": "#/components/parameters/page", + "url": null + }, + { + "ref": "#/components/parameters/page_size", + "url": null + }, { "ref": "#/components/responses/Forbidden", "url": null @@ -5792,7 +5766,7 @@ "deprecated": null, "description": "Checks whether the repository has any tags.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "headV2NamespacesByNamespaceRepositoriesByRepositoryTags", - "line": 1150, + "line": 1103, "method": "HEAD", "parameters": [ { @@ -5951,7 +5925,7 @@ "deprecated": null, "description": "Returns details for a specific tag in the specified repository.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "GetRepositoryTag", - "line": 1173, + "line": 1126, "method": "GET", "parameters": [ { @@ -6162,7 +6136,7 @@ "deprecated": null, "description": "Checks whether the specified tag exists in the repository.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "headV2NamespacesByNamespaceRepositoriesByRepositoryTagsByTag", - "line": 1191, + "line": 1144, "method": "HEAD", "parameters": [ { @@ -6326,58 +6300,59 @@ }, { "acceptMedia": "application/json", - "curl": "curl \\\n --request GET \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n 'https://hub.docker.com/v2/orgs/{name}/access-tokens'", + "curl": "curl \\\n --request GET \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n 'https://hub.docker.com/v2/orgs/myorganization/access-tokens'", "curlNotes": [], "deprecated": null, "description": "List access tokens for an organization.\n", "id": "getV2OrgsByNameAccessTokens", - "line": 1002, + "line": 975, "method": "GET", "parameters": [ { - "description": "Page number to return.", - "in": "query", - "name": "page", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/parameters/0", + "description": "Name of the organization (namespace).", + "example": "myorganization", + "in": "path", + "name": "org_name", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/parameters/0", + "required": true, "schema": { - "default": 1, - "type": "number" + "type": "string" } }, { - "description": "Number of results per page.", + "description": "Page number (starts on 1).", + "in": "query", + "name": "page", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/parameters/0", + "required": false, + "schema": { + "default": 1, + "type": "integer" + } + }, + { + "description": "Number of items (rows) per page.", "in": "query", "name": "page_size", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/parameters/1", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/parameters/1", + "required": false, "schema": { "default": 10, - "type": "number" + "type": "integer" } } ], - "path": "/v2/orgs/{name}/access-tokens", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get", + "path": "/v2/orgs/{org_name}/access-tokens", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get", "raw": { "description": "List access tokens for an organization.\n", "operationId": "getV2OrgsByNameAccessTokens", "parameters": [ { - "description": "Page number to return.", - "in": "query", - "name": "page", - "schema": { - "default": 1, - "type": "number" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of results per page.", - "in": "query", - "name": "page_size", - "schema": { - "default": 10, - "type": "number" - } + "$ref": "#/components/parameters/page_size" } ], "responses": { @@ -6412,6 +6387,14 @@ ] }, "references": [ + { + "ref": "#/components/parameters/page", + "url": null + }, + { + "ref": "#/components/parameters/page_size", + "url": null + }, { "ref": "#/components/responses/Forbidden", "url": null @@ -6492,7 +6475,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/responses/200/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/responses/200/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/getOrgAccessTokensResponse" @@ -6515,7 +6498,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/responses/401/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/responses/401/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6538,7 +6521,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/responses/403/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/responses/403/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6561,7 +6544,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/get/responses/404/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/get/responses/404/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6572,16 +6555,28 @@ }, { "acceptMedia": "application/json", - "curl": "curl \\\n --request POST \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"description\": \"Token for CI/CD pipeline\",\n \"label\": \"My organization token\",\n \"resources\": [\n {\n \"path\": \"myorg/myrepo\",\n \"scopes\": [\n \"scope-image-pull\"\n ],\n \"type\": \"TYPE_REPO\"\n }\n ]\n}' \\\n 'https://hub.docker.com/v2/orgs/{name}/access-tokens'", + "curl": "curl \\\n --request POST \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"description\": \"Token for CI/CD pipeline\",\n \"label\": \"My organization token\",\n \"resources\": [\n {\n \"path\": \"myorg/myrepo\",\n \"scopes\": [\n \"scope-image-pull\"\n ],\n \"type\": \"TYPE_REPO\"\n }\n ]\n}' \\\n 'https://hub.docker.com/v2/orgs/myorganization/access-tokens'", "curlNotes": [], "deprecated": null, "description": "Create an access token for an organization.\n", "id": "postV2OrgsByNameAccessTokens", - "line": 972, + "line": 945, "method": "POST", - "parameters": [], - "path": "/v2/orgs/{name}/access-tokens", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post", + "parameters": [ + { + "description": "Name of the organization (namespace).", + "example": "myorganization", + "in": "path", + "name": "org_name", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/parameters/0", + "required": true, + "schema": { + "type": "string" + } + } + ], + "path": "/v2/orgs/{org_name}/access-tokens", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post", "raw": { "description": "Create an access token for an organization.\n", "operationId": "postV2OrgsByNameAccessTokens", @@ -6717,7 +6712,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/requestBody/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/requestBody/content/application~1json", "required": true, "schema": { "$ref": "#/components/schemas/createOrgAccessTokenRequest" @@ -6754,7 +6749,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/responses/201/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/responses/201/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/createOrgAccessTokenResponse" @@ -6777,7 +6772,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/responses/400/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/responses/400/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6800,7 +6795,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/responses/401/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/responses/401/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6823,7 +6818,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/responses/403/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/responses/403/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -6846,547 +6841,7 @@ ], "headers": null, "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1access-tokens/post/responses/404/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "404" - } - ] - }, - { - "acceptMedia": "application/json", - "curl": "curl \\\n --request GET \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n 'https://hub.docker.com/v2/orgs/\u003cNAME\u003e/settings'", - "curlNotes": [], - "deprecated": null, - "description": "Returns organization settings by name.\n", - "id": "getV2OrgsByNameSettings", - "line": 901, - "method": "GET", - "parameters": [ - { - "description": "Name of the organization.", - "in": "path", - "name": "name", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/parameters/0", - "required": true, - "schema": { - "type": "string" - } - } - ], - "path": "/v2/orgs/{name}/settings", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/get", - "raw": { - "description": "Returns organization settings by name.\n", - "operationId": "getV2OrgsByNameSettings", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/orgSettings" - } - } - }, - "description": "OK" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get organization settings", - "tags": [ - "org-settings" - ] - }, - "references": [ - { - "ref": "#/components/responses/Forbidden", - "url": null - }, - { - "ref": "#/components/responses/NotFound", - "url": null - }, - { - "ref": "#/components/responses/Unauthorized", - "url": null - }, - { - "ref": "#/components/schemas/orgSettings", - "url": "/reference/api/hub/latest/schemas/orgSettings/" - } - ], - "requestSchema": null, - "security": [ - { - "bearerAuth": [] - } - ], - "securitySchemes": { - "bearerAuth": { - "bearerFormat": "JWT", - "scheme": "bearer", - "type": "http" - }, - "bearerSCIMAuth": { - "scheme": "bearer", - "type": "http" - }, - "scimToken": { - "description": "Use the SCIM provisioning token configured for the organization.", - "scheme": "bearer", - "type": "http" - } - }, - "servers": [ - { - "description": "Docker HUB API", - "url": "https://hub.docker.com", - "x-audience": "public" - } - ], - "summary": "Get organization settings", - "tags": [ - "org-settings" - ], - "url": "/reference/api/hub/latest/operations/getV2OrgsByNameSettings/", - "variants": [ - { - "description": "OK", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "Schema example", - "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", - "value": { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/get/responses/200/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/orgSettings" - }, - "status": "200" - }, - { - "description": "Unauthorized", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"unauthorized\"\n}", - "value": { - "errinfo": null, - "message": "unauthorized" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/get/responses/401/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "401" - }, - { - "description": "Forbidden", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"permission denied\"\n}", - "value": { - "errinfo": null, - "message": "permission denied" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/get/responses/403/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "403" - }, - { - "description": "Not Found", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"not found\"\n}", - "value": { - "errinfo": null, - "message": "not found" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/get/responses/404/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "404" - } - ] - }, - { - "acceptMedia": "application/json", - "curl": "curl \\\n --request PUT \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}' \\\n 'https://hub.docker.com/v2/orgs/\u003cNAME\u003e/settings'", - "curlNotes": [], - "deprecated": null, - "description": "Updates an organization's settings. Some settings are only used when the organization is on a business subscription.\n\n***Only users with administrative privileges for the organization (owner role) can modify these settings.***\n\nThe following settings are only used on a business subscription:\n- `restricted_images`\n", - "id": "putV2OrgsByNameSettings", - "line": 923, - "method": "PUT", - "parameters": [ - { - "description": "Name of the organization.", - "in": "path", - "name": "name", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/parameters/0", - "required": true, - "schema": { - "type": "string" - } - } - ], - "path": "/v2/orgs/{name}/settings", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put", - "raw": { - "description": "Updates an organization's settings. Some settings are only used when the organization is on a business subscription.\n\n***Only users with administrative privileges for the organization (owner role) can modify these settings.***\n\nThe following settings are only used on a business subscription:\n- `restricted_images`\n", - "operationId": "putV2OrgsByNameSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "examples": [ - { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - ], - "properties": { - "restricted_images": { - "allOf": [ - { - "$ref": "#/components/schemas/restricted_images" - }, - { - "required": [ - "enabled", - "allow_official_images", - "allow_verified_publishers" - ], - "type": "object" - } - ] - } - }, - "required": [ - "restricted_images" - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/orgSettings" - } - } - }, - "description": "OK" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update organization settings", - "tags": [ - "org-settings" - ] - }, - "references": [ - { - "ref": "#/components/responses/Forbidden", - "url": null - }, - { - "ref": "#/components/responses/NotFound", - "url": null - }, - { - "ref": "#/components/responses/Unauthorized", - "url": null - }, - { - "ref": "#/components/schemas/orgSettings", - "url": "/reference/api/hub/latest/schemas/orgSettings/" - }, - { - "ref": "#/components/schemas/restricted_images", - "url": "/reference/api/hub/latest/schemas/restricted_images/" - } - ], - "requestSchema": { - "examples": [ - { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - ], - "properties": { - "restricted_images": { - "allOf": [ - { - "$ref": "#/components/schemas/restricted_images" - }, - { - "required": [ - "enabled", - "allow_official_images", - "allow_verified_publishers" - ], - "type": "object" - } - ] - } - }, - "required": [ - "restricted_images" - ] - }, - "security": [ - { - "bearerAuth": [] - } - ], - "securitySchemes": { - "bearerAuth": { - "bearerFormat": "JWT", - "scheme": "bearer", - "type": "http" - }, - "bearerSCIMAuth": { - "scheme": "bearer", - "type": "http" - }, - "scimToken": { - "description": "Use the SCIM provisioning token configured for the organization.", - "scheme": "bearer", - "type": "http" - } - }, - "servers": [ - { - "description": "Docker HUB API", - "url": "https://hub.docker.com", - "x-audience": "public" - } - ], - "summary": "Update organization settings", - "tags": [ - "org-settings" - ], - "url": "/reference/api/hub/latest/operations/putV2OrgsByNameSettings/", - "variants": [ - { - "description": null, - "direction": "Request", - "examples": [ - { - "language": "json", - "name": "Schema example", - "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", - "value": { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put/requestBody/content/application~1json", - "required": true, - "schema": { - "examples": [ - { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - ], - "properties": { - "restricted_images": { - "allOf": [ - { - "$ref": "#/components/schemas/restricted_images" - }, - { - "required": [ - "enabled", - "allow_official_images", - "allow_verified_publishers" - ], - "type": "object" - } - ] - } - }, - "required": [ - "restricted_images" - ] - }, - "status": "" - }, - { - "description": "OK", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "Schema example", - "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", - "value": { - "restricted_images": { - "allow_official_images": true, - "allow_verified_publishers": true, - "enabled": true - } - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put/responses/200/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/orgSettings" - }, - "status": "200" - }, - { - "description": "Unauthorized", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"unauthorized\"\n}", - "value": { - "errinfo": null, - "message": "unauthorized" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put/responses/401/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "401" - }, - { - "description": "Forbidden", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"permission denied\"\n}", - "value": { - "errinfo": null, - "message": "permission denied" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put/responses/403/content/application~1json", - "required": null, - "schema": { - "$ref": "#/components/schemas/error" - }, - "status": "403" - }, - { - "description": "Not Found", - "direction": "Response", - "examples": [ - { - "language": "json", - "name": "error", - "text": "{\n \"errinfo\": null,\n \"message\": \"not found\"\n}", - "value": { - "errinfo": null, - "message": "not found" - } - } - ], - "headers": null, - "media": "application/json", - "pointer": "/paths/~1v2~1orgs~1{name}~1settings/put/responses/404/content/application~1json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens/post/responses/404/content/application~1json", "required": null, "schema": { "$ref": "#/components/schemas/error" @@ -7402,7 +6857,7 @@ "deprecated": null, "description": "Get details of a specific access token for an organization.\n", "id": "getV2OrgsByOrgNameAccessTokensByAccessTokenId", - "line": 1047, + "line": 1010, "method": "GET", "parameters": [ { @@ -7632,7 +7087,7 @@ "deprecated": null, "description": "Delete a specific access token for an organization. This action cannot be undone.\n", "id": "deleteV2OrgsByOrgNameAccessTokensByAccessTokenId", - "line": 1097, + "line": 1060, "method": "DELETE", "parameters": [ { @@ -7823,7 +7278,7 @@ "deprecated": null, "description": "Update a specific access token for an organization.\n", "id": "patchV2OrgsByOrgNameAccessTokensByAccessTokenId", - "line": 1069, + "line": 1032, "method": "PATCH", "parameters": [ { @@ -8102,7 +7557,7 @@ "deprecated": null, "description": "Get groups of an organization.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameGroups", - "line": 1836, + "line": 1774, "method": "GET", "parameters": [ { @@ -8121,7 +7576,9 @@ "in": "query", "name": "page", "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/0", + "required": false, "schema": { + "default": 1, "type": "integer" } }, @@ -8130,7 +7587,9 @@ "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups/get/parameters/1", + "required": false, "schema": { + "default": 10, "type": "integer" } }, @@ -8472,7 +7931,7 @@ "deprecated": null, "description": "Create a new group within an organization.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "postV2OrgsByOrgNameGroups", - "line": 1902, + "line": 1840, "method": "POST", "parameters": [ { @@ -8763,7 +8222,7 @@ "deprecated": null, "description": "Get a group of an organization.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameGroupsByGroupName", - "line": 1945, + "line": 1883, "method": "GET", "parameters": [ { @@ -8983,7 +8442,7 @@ "deprecated": null, "description": "Update the details for an organization group.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "putV2OrgsByOrgNameGroupsByGroupName", - "line": 1969, + "line": 1907, "method": "PUT", "parameters": [ { @@ -9285,7 +8744,7 @@ "deprecated": null, "description": "Delete an organization group.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "deleteV2OrgsByOrgNameGroupsByGroupName", - "line": 2050, + "line": 1988, "method": "DELETE", "parameters": [ { @@ -9476,7 +8935,7 @@ "deprecated": null, "description": "Update some details for an organization group.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "patchV2OrgsByOrgNameGroupsByGroupName", - "line": 2007, + "line": 1945, "method": "PATCH", "parameters": [ { @@ -9781,7 +9240,7 @@ "deprecated": null, "description": "List the members (users) that are in a group.\nIf user is owner of the org or has otherwise elevated permissions, they can search by email and the result will also contain emails.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameGroupsByGroupNameMembers", - "line": 2072, + "line": 2010, "method": "GET", "parameters": [ { @@ -9811,7 +9270,9 @@ "in": "query", "name": "page", "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups~1{group_name}~1members/get/parameters/2", + "required": false, "schema": { + "default": 1, "type": "integer" } }, @@ -9820,12 +9281,14 @@ "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups~1{group_name}~1members/get/parameters/3", + "required": false, "schema": { + "default": 10, "type": "integer" } }, { - "description": "Search members by username, full_name or email.", + "description": "Search members by username, full_name or email", "in": "query", "name": "search", "pointer": "/paths/~1v2~1orgs~1{org_name}~1groups~1{group_name}~1members/get/parameters/4", @@ -9853,12 +9316,7 @@ "$ref": "#/components/parameters/page_size" }, { - "description": "Search members by username, full_name or email.", - "in": "query", - "name": "search", - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/search" } ], "responses": { @@ -9952,6 +9410,10 @@ "ref": "#/components/parameters/page_size", "url": null }, + { + "ref": "#/components/parameters/search", + "url": null + }, { "ref": "#/components/responses/forbidden", "url": null @@ -10159,7 +9621,7 @@ "deprecated": null, "description": "Add a member to a group.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "postV2OrgsByOrgNameGroupsByGroupNameMembers", - "line": 2136, + "line": 2070, "method": "POST", "parameters": [ { @@ -10455,7 +9917,7 @@ "deprecated": null, "description": "Remove a user from a group.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "deleteV2OrgsByOrgNameGroupsByGroupNameMembersByUsername", - "line": 2169, + "line": 2103, "method": "DELETE", "parameters": [ { @@ -10657,7 +10119,7 @@ "deprecated": null, "description": "Return all pending invites for a given org, only team owners can call this endpoint\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameInvites", - "line": 1795, + "line": 1733, "method": "GET", "parameters": [ { @@ -10914,7 +10376,7 @@ "deprecated": null, "description": "Returns a list of members for an organization.\n\n_The following fields are only visible to orgs with insights enabled._\n\n- `last_logged_in_at`\n- `last_seen_at`\n- `last_desktop_version`\n\nTo make visible, please see [View Insights for organization users](https://docs.docker.com/accounts/organization/insights/#view-insights-for-organization-users).\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameMembers", - "line": 1647, + "line": 1585, "method": "GET", "parameters": [ { @@ -10929,12 +10391,12 @@ } }, { - "description": "Search term.", + "description": "Search members by username, full_name or email", "in": "query", "name": "search", "pointer": "/paths/~1v2~1orgs~1{org_name}~1members/parameters/1", "schema": { - "type": "integer" + "type": "string" } }, { @@ -10942,7 +10404,9 @@ "in": "query", "name": "page", "pointer": "/paths/~1v2~1orgs~1{org_name}~1members/parameters/2", + "required": false, "schema": { + "default": 1, "type": "integer" } }, @@ -10951,7 +10415,9 @@ "in": "query", "name": "page_size", "pointer": "/paths/~1v2~1orgs~1{org_name}~1members/parameters/3", + "required": false, "schema": { + "default": 10, "type": "integer" } }, @@ -11231,7 +10697,7 @@ "deprecated": null, "description": "Export members of an organization as a CSV\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "getV2OrgsByOrgNameMembersExport", - "line": 1684, + "line": 1622, "method": "GET", "parameters": [ { @@ -11477,7 +10943,7 @@ "deprecated": null, "description": "Updates the role of a member in the organization.\n***Only users in the \"owners\" group of the organization can use this endpoint.***\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "putV2OrgsByOrgNameMembersByUsername", - "line": 1724, + "line": 1662, "method": "PUT", "parameters": [ { @@ -11808,7 +11274,7 @@ "deprecated": null, "description": "Removes the member from the org, ie. all groups in the org, unless they're the last owner\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "deleteV2OrgsByOrgNameMembersByUsername", - "line": 1769, + "line": 1707, "method": "DELETE", "parameters": [ { @@ -12022,6 +11488,548 @@ } ] }, + { + "acceptMedia": "application/json", + "curl": "curl \\\n --request GET \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n 'https://hub.docker.com/v2/orgs/myorganization/settings'", + "curlNotes": [], + "deprecated": null, + "description": "Returns organization settings by name.\n", + "id": "getV2OrgsByNameSettings", + "line": 872, + "method": "GET", + "parameters": [ + { + "description": "Name of the organization (namespace).", + "example": "myorganization", + "in": "path", + "name": "org_name", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/parameters/0", + "required": true, + "schema": { + "type": "string" + } + } + ], + "path": "/v2/orgs/{org_name}/settings", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/get", + "raw": { + "description": "Returns organization settings by name.\n", + "operationId": "getV2OrgsByNameSettings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/orgSettings" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + }, + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Get organization settings", + "tags": [ + "org-settings" + ] + }, + "references": [ + { + "ref": "#/components/responses/Forbidden", + "url": null + }, + { + "ref": "#/components/responses/NotFound", + "url": null + }, + { + "ref": "#/components/responses/Unauthorized", + "url": null + }, + { + "ref": "#/components/schemas/orgSettings", + "url": "/reference/api/hub/latest/schemas/orgSettings/" + } + ], + "requestSchema": null, + "security": [ + { + "bearerAuth": [] + } + ], + "securitySchemes": { + "bearerAuth": { + "bearerFormat": "JWT", + "scheme": "bearer", + "type": "http" + }, + "bearerSCIMAuth": { + "scheme": "bearer", + "type": "http" + }, + "scimToken": { + "description": "Use the SCIM provisioning token configured for the organization.", + "scheme": "bearer", + "type": "http" + } + }, + "servers": [ + { + "description": "Docker HUB API", + "url": "https://hub.docker.com", + "x-audience": "public" + } + ], + "summary": "Get organization settings", + "tags": [ + "org-settings" + ], + "url": "/reference/api/hub/latest/operations/getV2OrgsByNameSettings/", + "variants": [ + { + "description": "OK", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "Schema example", + "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", + "value": { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/get/responses/200/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/orgSettings" + }, + "status": "200" + }, + { + "description": "Unauthorized", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"unauthorized\"\n}", + "value": { + "errinfo": null, + "message": "unauthorized" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/get/responses/401/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "401" + }, + { + "description": "Forbidden", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"permission denied\"\n}", + "value": { + "errinfo": null, + "message": "permission denied" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/get/responses/403/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "403" + }, + { + "description": "Not Found", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"not found\"\n}", + "value": { + "errinfo": null, + "message": "not found" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/get/responses/404/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "404" + } + ] + }, + { + "acceptMedia": "application/json", + "curl": "curl \\\n --request PUT \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}' \\\n 'https://hub.docker.com/v2/orgs/myorganization/settings'", + "curlNotes": [], + "deprecated": null, + "description": "Updates an organization's settings. Some settings are only used when the organization is on a business subscription.\n\n***Only users with administrative privileges for the organization (owner role) can modify these settings.***\n\nThe following settings are only used on a business subscription:\n- `restricted_images`\n", + "id": "putV2OrgsByNameSettings", + "line": 894, + "method": "PUT", + "parameters": [ + { + "description": "Name of the organization (namespace).", + "example": "myorganization", + "in": "path", + "name": "org_name", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/parameters/0", + "required": true, + "schema": { + "type": "string" + } + } + ], + "path": "/v2/orgs/{org_name}/settings", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put", + "raw": { + "description": "Updates an organization's settings. Some settings are only used when the organization is on a business subscription.\n\n***Only users with administrative privileges for the organization (owner role) can modify these settings.***\n\nThe following settings are only used on a business subscription:\n- `restricted_images`\n", + "operationId": "putV2OrgsByNameSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "examples": [ + { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + ], + "properties": { + "restricted_images": { + "allOf": [ + { + "$ref": "#/components/schemas/restricted_images" + }, + { + "required": [ + "enabled", + "allow_official_images", + "allow_verified_publishers" + ], + "type": "object" + } + ] + } + }, + "required": [ + "restricted_images" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/orgSettings" + } + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + }, + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Update organization settings", + "tags": [ + "org-settings" + ] + }, + "references": [ + { + "ref": "#/components/responses/Forbidden", + "url": null + }, + { + "ref": "#/components/responses/NotFound", + "url": null + }, + { + "ref": "#/components/responses/Unauthorized", + "url": null + }, + { + "ref": "#/components/schemas/orgSettings", + "url": "/reference/api/hub/latest/schemas/orgSettings/" + }, + { + "ref": "#/components/schemas/restricted_images", + "url": "/reference/api/hub/latest/schemas/restricted_images/" + } + ], + "requestSchema": { + "examples": [ + { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + ], + "properties": { + "restricted_images": { + "allOf": [ + { + "$ref": "#/components/schemas/restricted_images" + }, + { + "required": [ + "enabled", + "allow_official_images", + "allow_verified_publishers" + ], + "type": "object" + } + ] + } + }, + "required": [ + "restricted_images" + ] + }, + "security": [ + { + "bearerAuth": [] + } + ], + "securitySchemes": { + "bearerAuth": { + "bearerFormat": "JWT", + "scheme": "bearer", + "type": "http" + }, + "bearerSCIMAuth": { + "scheme": "bearer", + "type": "http" + }, + "scimToken": { + "description": "Use the SCIM provisioning token configured for the organization.", + "scheme": "bearer", + "type": "http" + } + }, + "servers": [ + { + "description": "Docker HUB API", + "url": "https://hub.docker.com", + "x-audience": "public" + } + ], + "summary": "Update organization settings", + "tags": [ + "org-settings" + ], + "url": "/reference/api/hub/latest/operations/putV2OrgsByNameSettings/", + "variants": [ + { + "description": null, + "direction": "Request", + "examples": [ + { + "language": "json", + "name": "Schema example", + "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", + "value": { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put/requestBody/content/application~1json", + "required": true, + "schema": { + "examples": [ + { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + ], + "properties": { + "restricted_images": { + "allOf": [ + { + "$ref": "#/components/schemas/restricted_images" + }, + { + "required": [ + "enabled", + "allow_official_images", + "allow_verified_publishers" + ], + "type": "object" + } + ] + } + }, + "required": [ + "restricted_images" + ] + }, + "status": "" + }, + { + "description": "OK", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "Schema example", + "text": "{\n \"restricted_images\": {\n \"allow_official_images\": true,\n \"allow_verified_publishers\": true,\n \"enabled\": true\n }\n}", + "value": { + "restricted_images": { + "allow_official_images": true, + "allow_verified_publishers": true, + "enabled": true + } + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put/responses/200/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/orgSettings" + }, + "status": "200" + }, + { + "description": "Unauthorized", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"unauthorized\"\n}", + "value": { + "errinfo": null, + "message": "unauthorized" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put/responses/401/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "401" + }, + { + "description": "Forbidden", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"permission denied\"\n}", + "value": { + "errinfo": null, + "message": "permission denied" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put/responses/403/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "403" + }, + { + "description": "Not Found", + "direction": "Response", + "examples": [ + { + "language": "json", + "name": "error", + "text": "{\n \"errinfo\": null,\n \"message\": \"not found\"\n}", + "value": { + "errinfo": null, + "message": "not found" + } + } + ], + "headers": null, + "media": "application/json", + "pointer": "/paths/~1v2~1orgs~1{org_name}~1settings/put/responses/404/content/application~1json", + "required": null, + "schema": { + "$ref": "#/components/schemas/error" + }, + "status": "404" + } + ] + }, { "acceptMedia": "application/json", "curl": "curl \\\n --request POST \\\n --header \"Authorization: Bearer ${TOKEN}\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"group_id\": 12345,\n \"permission\": \"write\"\n}' \\\n 'https://hub.docker.com/v2/repositories/\u003cNAMESPACE\u003e/\u003cREPOSITORY\u003e/groups'", @@ -12029,7 +12037,7 @@ "deprecated": null, "description": "Assigns an organization group (team) to a repository with a specified permission level.\n\nThis operation accepts bearer tokens issued from organization access tokens (OATs). The token must have the required resource access and scopes.\n", "id": "CreateRepositoryGroup", - "line": 1273, + "line": 1226, "method": "POST", "parameters": [ { @@ -12338,7 +12346,7 @@ "deprecated": null, "description": "Returns all resource types supported for the SCIM configuration.\n", "id": "getV2Scim20ResourceTypes", - "line": 2295, + "line": 2229, "method": "GET", "parameters": [], "path": "/v2/scim/2.0/ResourceTypes", @@ -12573,7 +12581,7 @@ "deprecated": null, "description": "Returns a resource type by name.\n", "id": "getV2Scim20ResourceTypesByName", - "line": 2313, + "line": 2247, "method": "GET", "parameters": [ { @@ -12828,7 +12836,7 @@ "deprecated": null, "description": "Returns all schemas supported for the SCIM configuration.\n", "id": "getV2Scim20Schemas", - "line": 2341, + "line": 2275, "method": "GET", "parameters": [], "path": "/v2/scim/2.0/Schemas", @@ -13061,7 +13069,7 @@ "deprecated": null, "description": "Returns a schema by ID.\n", "id": "getV2Scim20SchemasById", - "line": 2359, + "line": 2293, "method": "GET", "parameters": [ { @@ -13315,7 +13323,7 @@ "deprecated": null, "description": "Returns a service provider config for Docker's configuration.\n", "id": "getV2Scim20ServiceProviderConfig", - "line": 2277, + "line": 2211, "method": "GET", "parameters": [], "path": "/v2/scim/2.0/ServiceProviderConfig", @@ -13526,7 +13534,7 @@ "deprecated": null, "description": "Returns paginated users for an organization. Use `startIndex` and `count` query parameters to receive paginated results.\n\n**Sorting:**\n\nSorting allows you to specify the order in which resources are returned by specifying a combination of `sortBy` and `sortOrder` query parameters.\n\nThe `sortBy` parameter specifies the attribute whose value will be used to order the returned responses. The `sortOrder` parameter defines the order in which the `sortBy` parameter is applied. Allowed values are \"ascending\" and \"descending\".\n\n**Filtering:**\n\nYou can request a subset of resources by specifying the `filter` query parameter containing a filter expression. Attribute names and attribute operators used in filters are case insensitive. The filter parameter must contain at least one valid expression. Each expression must contain an attribute name followed by an attribute operator and an optional value.\n\nSupported operators are listed below.\n\n- `eq` equal\n- `ne` not equal\n- `co` contains\n- `sw` starts with\n- `and` Logical \"and\"\n- `or` Logical \"or\"\n- `not` \"Not\" function\n- `()` Precedence grouping\n", "id": "getV2Scim20Users", - "line": 2387, + "line": 2321, "method": "GET", "parameters": [ { @@ -14079,7 +14087,7 @@ "deprecated": null, "description": "Creates a user. If the user already exists by email, they are assigned to the organization on the \"company\" team.\n", "id": "postV2Scim20Users", - "line": 2467, + "line": 2401, "method": "POST", "parameters": [], "path": "/v2/scim/2.0/Users", @@ -14557,7 +14565,7 @@ "deprecated": null, "description": "Returns a user by ID.\n", "id": "getV2Scim20UsersById", - "line": 2497, + "line": 2431, "method": "GET", "parameters": [ { @@ -14912,7 +14920,7 @@ "deprecated": null, "description": "Updates a user. This route is used to change the user's name, activate, and deactivate the user.\n", "id": "putV2Scim20UsersById", - "line": 2519, + "line": 2453, "method": "PUT", "parameters": [ { @@ -15413,7 +15421,7 @@ "curl": "curl \\\n --request POST \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"code\": \"123456\",\n \"login_2fa_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n}' \\\n 'https://hub.docker.com/v2/users/2fa-login'", "curlNotes": [], "deprecated": null, - "description": "When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/users/login` call.\n\nCreates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.\n\nThe returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.\n\nMost Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.\n", + "description": "When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/auth/token` call.\n\nCreates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.\n\nThe returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.\n\nMost Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.\n", "id": "PostUsers2FALogin", "line": 218, "method": "POST", @@ -15421,7 +15429,7 @@ "path": "/v2/users/2fa-login", "pointer": "/paths/~1v2~1users~12fa-login/post", "raw": { - "description": "When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/users/login` call.\n\nCreates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.\n\nThe returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.\n\nMost Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.\n", + "description": "When a user has two-factor authentication (2FA) enabled, this is the second call to perform after `/v2/auth/token` call.\n\nCreates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.\n\nThe returned token is used in the HTTP Authorization header like `Authorization: Bearer {TOKEN}`.\n\nMost Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.\n", "operationId": "PostUsers2FALogin", "requestBody": { "content": { @@ -15752,7 +15760,7 @@ ], "owner": "docker/docs", "product": "hub", - "schemaCount": 209, + "schemaCount": 197, "schemaURLs": { "#/components/schemas/AuditLog": "/reference/api/hub/latest/schemas/AuditLog/", "#/components/schemas/AuditLogAction": "/reference/api/hub/latest/schemas/AuditLogAction/", @@ -16115,7 +16123,7 @@ "type": "string" }, "login_2fa_token": { - "description": "The intermediate 2FA token returned from `/v2/users/login` API.", + "description": "The intermediate 2FA token returned from `/v2/auth/token` API.", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "type": "string" }