Skip to content

Commit a57ea3e

Browse files
feat: document OATs public APIs
1 parent a340504 commit a57ea3e

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

content/reference/api/hub/latest.yaml

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,6 +738,81 @@ paths:
738738
'404':
739739
$ref: '#/components/responses/NotFound'
740740

741+
/v2/orgs/{org_name}/access-tokens/{access_token_id}:
742+
parameters:
743+
- $ref: '#/components/parameters/org_name'
744+
- in: path
745+
name: access_token_id
746+
required: true
747+
schema:
748+
type: string
749+
description: The ID of the access token to retrieve
750+
example: "a7a5ef25-8889-43a0-8cc7-f2a94268e861"
751+
get:
752+
summary: Get access token
753+
description: |
754+
Get details of a specific access token for an organization.
755+
tags:
756+
- access-tokens
757+
security:
758+
- bearerAuth: []
759+
responses:
760+
'200':
761+
description: OK
762+
content:
763+
application/json:
764+
schema:
765+
$ref: '#/components/schemas/getOrgAccessTokenResponse'
766+
'401':
767+
$ref: '#/components/responses/Unauthorized'
768+
'403':
769+
$ref: '#/components/responses/Forbidden'
770+
'404':
771+
$ref: '#/components/responses/NotFound'
772+
patch:
773+
summary: Update access token
774+
description: |
775+
Update a specific access token for an organization.
776+
tags:
777+
- access-tokens
778+
security:
779+
- bearerAuth: []
780+
requestBody:
781+
content:
782+
application/json:
783+
schema:
784+
$ref: '#/components/schemas/updateOrgAccessTokenRequest'
785+
required: true
786+
responses:
787+
'200':
788+
description: OK
789+
content:
790+
application/json:
791+
schema:
792+
$ref: '#/components/schemas/updateOrgAccessTokenResponse'
793+
'401':
794+
$ref: '#/components/responses/Unauthorized'
795+
'403':
796+
$ref: '#/components/responses/Forbidden'
797+
'404':
798+
$ref: '#/components/responses/NotFound'
799+
delete:
800+
summary: Delete access token
801+
description: |
802+
Delete a specific access token for an organization. This action cannot be undone.
803+
tags:
804+
- access-tokens
805+
security:
806+
- bearerAuth: []
807+
responses:
808+
'204':
809+
description: Access token deleted successfully
810+
'401':
811+
$ref: '#/components/responses/Unauthorized'
812+
'403':
813+
$ref: '#/components/responses/Forbidden'
814+
'404':
815+
$ref: '#/components/responses/NotFound'
741816
/v2/namespaces/{namespace}/repositories/{repository}/tags:
742817
parameters:
743818
- $ref: '#/components/parameters/namespace'
@@ -2929,6 +3004,16 @@ components:
29293004
type: array
29303005
items:
29313006
$ref: '#/components/schemas/orgAccessToken'
3007+
getOrgAccessTokenResponse:
3008+
allOf:
3009+
- $ref: '#/components/schemas/orgAccessToken'
3010+
- type: object
3011+
properties:
3012+
resources:
3013+
type: array
3014+
description: Resources this token has access to
3015+
items:
3016+
$ref: '#/components/schemas/orgAccessTokenResource'
29323017
createOrgAccessTokenRequest:
29333018
type: object
29343019
properties:
@@ -2966,7 +3051,17 @@ components:
29663051
type: array
29673052
items:
29683053
$ref: '#/components/schemas/orgAccessTokenResource'
2969-
3054+
updateOrgAccessTokenResponse:
3055+
type: object
3056+
allOf:
3057+
- $ref: '#/components/schemas/orgAccessToken'
3058+
- type: object
3059+
properties:
3060+
resources:
3061+
type: array
3062+
description: Resources this token has access to
3063+
items:
3064+
$ref: '#/components/schemas/orgAccessTokenResource'
29703065
parameters:
29713066
namespace:
29723067
in: path

0 commit comments

Comments
 (0)