Skip to content

Commit 6167eef

Browse files
feat: document OATs public APIs
1 parent ecb58d1 commit 6167eef

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
@@ -729,6 +729,81 @@ paths:
729729
'404':
730730
$ref: '#/components/responses/NotFound'
731731

732+
/v2/orgs/{org_name}/access-tokens/{access_token_id}:
733+
parameters:
734+
- $ref: '#/components/parameters/org_name'
735+
- in: path
736+
name: access_token_id
737+
required: true
738+
schema:
739+
type: string
740+
description: The ID of the access token to retrieve
741+
example: "a7a5ef25-8889-43a0-8cc7-f2a94268e861"
742+
get:
743+
summary: Get access token
744+
description: |
745+
Get details of a specific access token for an organization.
746+
tags:
747+
- access-tokens
748+
security:
749+
- bearerAuth: []
750+
responses:
751+
'200':
752+
description: OK
753+
content:
754+
application/json:
755+
schema:
756+
$ref: '#/components/schemas/getOrgAccessTokenResponse'
757+
'401':
758+
$ref: '#/components/responses/Unauthorized'
759+
'403':
760+
$ref: '#/components/responses/Forbidden'
761+
'404':
762+
$ref: '#/components/responses/NotFound'
763+
patch:
764+
summary: Update access token
765+
description: |
766+
Update a specific access token for an organization.
767+
tags:
768+
- access-tokens
769+
security:
770+
- bearerAuth: []
771+
requestBody:
772+
content:
773+
application/json:
774+
schema:
775+
$ref: '#/components/schemas/updateOrgAccessTokenRequest'
776+
required: true
777+
responses:
778+
'200':
779+
description: OK
780+
content:
781+
application/json:
782+
schema:
783+
$ref: '#/components/schemas/updateOrgAccessTokenResponse'
784+
'401':
785+
$ref: '#/components/responses/Unauthorized'
786+
'403':
787+
$ref: '#/components/responses/Forbidden'
788+
'404':
789+
$ref: '#/components/responses/NotFound'
790+
delete:
791+
summary: Delete access token
792+
description: |
793+
Delete a specific access token for an organization. This action cannot be undone.
794+
tags:
795+
- access-tokens
796+
security:
797+
- bearerAuth: []
798+
responses:
799+
'204':
800+
description: Access token deleted successfully
801+
'401':
802+
$ref: '#/components/responses/Unauthorized'
803+
'403':
804+
$ref: '#/components/responses/Forbidden'
805+
'404':
806+
$ref: '#/components/responses/NotFound'
732807
/v2/namespaces/{namespace}/repositories/{repository}/tags:
733808
parameters:
734809
- $ref: '#/components/parameters/namespace'
@@ -2920,6 +2995,16 @@ components:
29202995
type: array
29212996
items:
29222997
$ref: '#/components/schemas/orgAccessToken'
2998+
getOrgAccessTokenResponse:
2999+
allOf:
3000+
- $ref: '#/components/schemas/orgAccessToken'
3001+
- type: object
3002+
properties:
3003+
resources:
3004+
type: array
3005+
description: Resources this token has access to
3006+
items:
3007+
$ref: '#/components/schemas/orgAccessTokenResource'
29233008
createOrgAccessTokenRequest:
29243009
type: object
29253010
properties:
@@ -2957,7 +3042,17 @@ components:
29573042
type: array
29583043
items:
29593044
$ref: '#/components/schemas/orgAccessTokenResource'
2960-
3045+
updateOrgAccessTokenResponse:
3046+
type: object
3047+
allOf:
3048+
- $ref: '#/components/schemas/orgAccessToken'
3049+
- type: object
3050+
properties:
3051+
resources:
3052+
type: array
3053+
description: Resources this token has access to
3054+
items:
3055+
$ref: '#/components/schemas/orgAccessTokenResource'
29613056
parameters:
29623057
namespace:
29633058
in: path

0 commit comments

Comments
 (0)