Skip to content

Commit 79df52c

Browse files
committed
feat(docs): document dependendents api endpoint
1 parent 430b509 commit 79df52c

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

apps/docs/public/openapi.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,19 @@ components:
10531053
items:
10541054
$ref: '#/components/schemas/Version'
10551055
description: Versions that the project depends upon
1056+
ProjectDependentsList:
1057+
type: object
1058+
properties:
1059+
projects:
1060+
type: array
1061+
items:
1062+
$ref: '#/components/schemas/Project'
1063+
description: Projects that that depend on the project
1064+
versions:
1065+
type: array
1066+
items:
1067+
$ref: '#/components/schemas/Version'
1068+
description: Versions that depend on the project
10561069
PatchProjectsBody:
10571070
type: object
10581071
properties:
@@ -2396,6 +2409,23 @@ paths:
23962409
$ref: '#/components/schemas/ProjectDependencyList'
23972410
'404':
23982411
description: The requested item(s) were not found or no authorization to access the requested item(s)
2412+
/project/{id|slug}/dependents:
2413+
parameters:
2414+
- $ref: '#/components/parameters/ProjectIdentifier'
2415+
get:
2416+
summary: Get all dependents for a project
2417+
operationId: getDependents
2418+
tags:
2419+
- projects
2420+
responses:
2421+
'200':
2422+
description: Expected response to a valid request
2423+
content:
2424+
application/json:
2425+
schema:
2426+
$ref: '#/components/schemas/ProjectDependentsList'
2427+
'404':
2428+
description: The requested item(s) were not found or no authorization to access the requested item(s)
23992429
/project/{id|slug}/follow:
24002430
parameters:
24012431
- $ref: '#/components/parameters/ProjectIdentifier'

0 commit comments

Comments
 (0)