Skip to content

Commit cdd8421

Browse files
prkhrkatprkhrkat
committed
corrected specs
1 parent 15b2a4f commit cdd8421

File tree

16 files changed

+154
-118
lines changed

16 files changed

+154
-118
lines changed

‎specs/deployment/core.yaml‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ info:
1414
servers:
1515
- url: http://localhost:8080
1616
paths:
17-
/deployment/template/validate:
17+
/orchestrator/deployment/template/validate:
1818
post:
1919
description: upload template file from this api to validate.
2020
requestBody:
@@ -43,14 +43,22 @@ paths:
4343
description: status
4444
result:
4545
$ref: '#/components/schemas/UploadTemplateResponse'
46+
'400':
47+
description: Bad request - validation error, unsupported format, or file parsing error
48+
'401':
49+
description: Unauthorized user
50+
'403':
51+
description: Forbidden - insufficient permissions
52+
'500':
53+
description: Internal server error
4654
default:
4755
description: unexpected error
4856
content:
4957
application/json:
5058
schema:
5159
$ref: '#/components/schemas/ErrorResponse'
5260

53-
/deployment/template/upload:
61+
/orchestrator/deployment/template/upload:
5462
put:
5563
description: upload template file from this api.
5664
requestBody:
@@ -76,14 +84,22 @@ paths:
7684
result:
7785
type: string
7886
description: result
87+
'400':
88+
description: Bad request - validation error
89+
'401':
90+
description: Unauthorized user
91+
'403':
92+
description: Forbidden - insufficient permissions
93+
'500':
94+
description: Internal server error
7995
default:
8096
description: unexpected error
8197
content:
8298
application/json:
8399
schema:
84100
$ref: '#/components/schemas/ErrorResponse'
85101

86-
/deployment/template/fetch:
102+
/orchestrator/deployment/template/fetch:
87103
get:
88104
summary: Returns all charts
89105
description: all the chart template uploaded by user
@@ -105,6 +121,10 @@ paths:
105121
description: list of charts
106122
items:
107123
$ref: '#/components/schemas/Chart'
124+
'401':
125+
description: Unauthorized user
126+
'500':
127+
description: Internal server error
108128
default:
109129
description: unexpected error
110130
content:

‎specs/external-links/external-links-specs.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ info:
33
version: 1.0.0
44
title: External links APIs
55
paths:
6-
/orchestrator/external-link/tools:
6+
/orchestrator/external-links/tools:
77
get:
88
description: Get all available monitoring tools for external links
99
responses:
@@ -15,7 +15,7 @@ paths:
1515
type: array
1616
items:
1717
$ref: "#/components/schemas/ExternalLinkMonitoringTool"
18-
/orchestrator/external-link:
18+
/orchestrator/external-links:
1919
get:
2020
description: Get All active External links (If query parameter is not supplied
2121
then it will give all external links otherwise it will give external links

‎specs/gitops/core.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ info:
1414
servers:
1515
- url: http://localhost:8080
1616
paths:
17-
/gitops/config:
17+
/orchestrator/gitops/config:
1818
post:
1919
description: Create or save new GitOps configuration and validate before saving
2020
operationId: CreateGitOpsConfig
@@ -128,7 +128,7 @@ paths:
128128
schema:
129129
$ref: '#/components/schemas/ErrorResponse'
130130

131-
/gitops/config/{id}:
131+
/orchestrator/gitops/config/{id}:
132132
get:
133133
description: Get GitOps configuration by ID
134134
operationId: GetGitOpsConfigById
@@ -171,7 +171,7 @@ paths:
171171
schema:
172172
$ref: '#/components/schemas/ErrorResponse'
173173

174-
/gitops/config-by-provider:
174+
/orchestrator/gitops/config-by-provider:
175175
get:
176176
description: Get GitOps configuration by provider
177177
operationId: GetGitOpsConfigByProvider
@@ -214,7 +214,7 @@ paths:
214214
schema:
215215
$ref: '#/components/schemas/ErrorResponse'
216216

217-
/gitops/configured:
217+
/orchestrator/gitops/configured:
218218
get:
219219
description: Check if GitOps is configured
220220
operationId: GitOpsConfigured
@@ -251,7 +251,7 @@ paths:
251251
schema:
252252
$ref: '#/components/schemas/ErrorResponse'
253253

254-
/gitops/validate:
254+
/orchestrator/gitops/validate:
255255
post:
256256
description: Validate GitOps configuration
257257
operationId: GitOpsValidator

‎specs/helm/provider.yaml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ servers:
1616

1717
paths:
1818
# Chart Provider APIs
19-
/chart-provider/list:
19+
/orchestrator/app-store/chart-provider/list:
2020
get:
2121
description: Get list of all chart providers
2222
operationId: GetChartProviderList
@@ -48,7 +48,7 @@ paths:
4848
schema:
4949
$ref: '#/components/schemas/ErrorResponse'
5050

51-
/chart-provider/update:
51+
/orchestrator/app-store/chart-provider/update:
5252
post:
5353
description: Toggle chart provider status
5454
operationId: ToggleChartProvider
@@ -94,7 +94,7 @@ paths:
9494
schema:
9595
$ref: '#/components/schemas/ErrorResponse'
9696

97-
/chart-provider/sync-chart:
97+
/orchestrator/app-store/chart-provider/sync-chart:
9898
post:
9999
description: Sync chart provider
100100
operationId: SyncChartProvider
@@ -141,7 +141,7 @@ paths:
141141
$ref: '#/components/schemas/ErrorResponse'
142142

143143
# Chart Repository APIs
144-
/chart-repo/{id}:
144+
/orchestrator/chart-repo/{id}:
145145
get:
146146
description: Get chart repository by ID
147147
operationId: GetChartRepoById
@@ -185,7 +185,7 @@ paths:
185185
schema:
186186
$ref: '#/components/schemas/ErrorResponse'
187187

188-
/chart-repo/list:
188+
/orchestrator/chart-repo/list:
189189
get:
190190
description: Get list of all chart repositories
191191
operationId: GetChartRepoList
@@ -217,7 +217,7 @@ paths:
217217
schema:
218218
$ref: '#/components/schemas/ErrorResponse'
219219

220-
/chart-repo:
220+
/orchestrator/chart-repo:
221221
post:
222222
description: Create a new chart repository
223223
operationId: CreateChartRepo
@@ -299,7 +299,7 @@ paths:
299299
schema:
300300
$ref: '#/components/schemas/ErrorResponse'
301301

302-
/chart-repo/validate:
302+
/orchestrator/chart-repo/validate:
303303
post:
304304
description: Validate chart repository configuration
305305
operationId: ValidateChartRepo
@@ -345,7 +345,7 @@ paths:
345345
schema:
346346
$ref: '#/components/schemas/ErrorResponse'
347347

348-
/chart-repo/sync:
348+
/orchestrator/chart-repo/sync:
349349
post:
350350
description: Trigger manual chart repository sync
351351
operationId: TriggerChartSyncManual
@@ -380,7 +380,7 @@ paths:
380380
$ref: '#/components/schemas/ErrorResponse'
381381

382382
# Chart Group APIs
383-
/chart-group:
383+
/orchestrator/chart-group:
384384
post:
385385
description: Create a new chart group
386386
operationId: CreateChartGroup
@@ -462,7 +462,7 @@ paths:
462462
schema:
463463
$ref: '#/components/schemas/ErrorResponse'
464464

465-
/chart-group/entries:
465+
/orchestrator/chart-group/entries:
466466
post:
467467
description: Save chart group entries
468468
operationId: SaveChartGroupEntries
@@ -508,7 +508,7 @@ paths:
508508
schema:
509509
$ref: '#/components/schemas/ErrorResponse'
510510

511-
/chart-group/list:
511+
/orchestrator/chart-group/list:
512512
get:
513513
description: Get list of all chart groups
514514
operationId: GetChartGroupList
@@ -540,7 +540,7 @@ paths:
540540
schema:
541541
$ref: '#/components/schemas/ErrorResponse'
542542

543-
/chart-group/{id}:
543+
/orchestrator/chart-group/{id}:
544544
delete:
545545
description: Delete a chart group
546546
operationId: DeleteChartGroup

‎specs/helm/repo-validation.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ info:
33
version: 1.0.0
44
title: Helm Chart Repo Validation
55
servers:
6-
- url: http://localhost:3000/orchestrator/app-store
6+
- url: http://localhost:3000/orchestrator/chart-repo
77
paths:
8-
/repo/validate:
8+
/validate:
99
post:
1010
description: Validate helm repo by checking index file
1111
operationId: ValidateChartRepo
@@ -47,7 +47,7 @@ paths:
4747
application/json:
4848
schema:
4949
$ref: '#/components/schemas/ErrorResponse'
50-
/repo/create:
50+
/create:
5151
post:
5252
description: Validate chart repo config and save if successfully validated
5353
operationId: ValidateAndCreateChartRepo
@@ -89,7 +89,7 @@ paths:
8989
application/json:
9090
schema:
9191
$ref: '#/components/schemas/ErrorResponse'
92-
/repo/update:
92+
/update:
9393
post:
9494
description: Validate configuration and update them if validation is successful
9595
operationId: ValidateAndUpdateChartRepo

‎specs/kubernetes/capacity.yaml‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,6 @@ paths:
1717
type: array
1818
items:
1919
$ref: '#/components/schemas/ClusterCapacityDetail'
20-
'400':
21-
description: Bad request
22-
content:
23-
application/json:
24-
schema:
25-
$ref: '#/components/schemas/Error'
2620
'401':
2721
description: Unauthorized
2822
content:
@@ -56,12 +50,6 @@ paths:
5650
type: array
5751
items:
5852
$ref: '#/components/schemas/ClusterCapacityDetail'
59-
'400':
60-
description: Bad request
61-
content:
62-
application/json:
63-
schema:
64-
$ref: '#/components/schemas/Error'
6553
'401':
6654
description: Unauthorized
6755
content:
@@ -101,7 +89,7 @@ paths:
10189
schema:
10290
$ref: '#/components/schemas/ClusterCapacityDetail'
10391
'400':
104-
description: Bad request
92+
description: Bad request - invalid clusterId format
10593
content:
10694
application/json:
10795
schema:
@@ -147,7 +135,7 @@ paths:
147135
items:
148136
$ref: '#/components/schemas/NodeCapacityDetail'
149137
'400':
150-
description: Bad request
138+
description: Bad request - invalid clusterId format
151139
content:
152140
application/json:
153141
schema:
@@ -197,7 +185,7 @@ paths:
197185
schema:
198186
$ref: '#/components/schemas/NodeCapacityDetail'
199187
'400':
200-
description: Bad request
188+
description: Bad request - invalid clusterId format or missing name
201189
content:
202190
application/json:
203191
schema:
@@ -239,7 +227,7 @@ paths:
239227
schema:
240228
$ref: '#/components/schemas/NodeManifestUpdateResponse'
241229
'400':
242-
description: Bad request
230+
description: Bad request - invalid request body
243231
content:
244232
application/json:
245233
schema:
@@ -281,7 +269,7 @@ paths:
281269
schema:
282270
$ref: '#/components/schemas/NodeManifestUpdateResponse'
283271
'400':
284-
description: Bad request
272+
description: Bad request - invalid request body
285273
content:
286274
application/json:
287275
schema:
@@ -324,7 +312,7 @@ paths:
324312
schema:
325313
type: string
326314
'400':
327-
description: Bad request
315+
description: Bad request - invalid request body
328316
content:
329317
application/json:
330318
schema:
@@ -367,7 +355,7 @@ paths:
367355
schema:
368356
type: string
369357
'400':
370-
description: Bad request
358+
description: Bad request - invalid request body
371359
content:
372360
application/json:
373361
schema:
@@ -410,7 +398,7 @@ paths:
410398
schema:
411399
type: string
412400
'400':
413-
description: Bad request
401+
description: Bad request - invalid request body
414402
content:
415403
application/json:
416404
schema:

‎specs/kubernetes/cluster.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ info:
1414
servers:
1515
- url: http://localhost:8080
1616
paths:
17-
/cluster:
17+
/orchestrator/cluster:
1818
put:
1919
description: Update Cluster
2020
operationId: UpdateCluster
@@ -96,7 +96,7 @@ paths:
9696
application/json:
9797
schema:
9898
$ref: '#/components/schemas/Error'
99-
/cluster/auth-list:
99+
/orchestrator/cluster/auth-list:
100100
get:
101101
description: list of accessible cluster
102102
responses:

0 commit comments

Comments
 (0)