Skip to content

Commit 8adcd46

Browse files
andricDuandricDu
committed
update docs with script
1 parent 5df8202 commit 8adcd46

11 files changed

+4043
-6106
lines changed

‎src/swagger/approval.json

+43-43
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"/v1/": {
1010
"get": {
1111
"summary": "Root",
12-
"description": "For testing if service's up",
12+
"description": "For testing if service's up.",
1313
"operationId": "root_v1__get",
1414
"responses": {
1515
"200": {
@@ -23,21 +23,21 @@
2323
}
2424
}
2525
},
26-
"/v1/request/copy/{project_geid}": {
26+
"/v1/request/copy/{project_code}": {
2727
"get": {
2828
"tags": [
2929
"CopyRequest"
3030
],
3131
"summary": "Create a copy request",
32-
"operationId": "list_requests_v1_request_copy__project_geid__get",
32+
"operationId": "list_requests_v1_request_copy__project_code__get",
3333
"parameters": [
3434
{
3535
"required": true,
3636
"schema": {
37-
"title": "Project Geid",
37+
"title": "Project Code",
3838
"type": "string"
3939
},
40-
"name": "project_geid",
40+
"name": "project_code",
4141
"in": "path"
4242
},
4343
{
@@ -127,15 +127,15 @@
127127
"CopyRequest"
128128
],
129129
"summary": "Approve files",
130-
"operationId": "complete_request_v1_request_copy__project_geid__put",
130+
"operationId": "complete_request_v1_request_copy__project_code__put",
131131
"parameters": [
132132
{
133133
"required": true,
134134
"schema": {
135-
"title": "Project Geid",
135+
"title": "Project Code",
136136
"type": "string"
137137
},
138-
"name": "project_geid",
138+
"name": "project_code",
139139
"in": "path"
140140
}
141141
],
@@ -177,15 +177,15 @@
177177
"CopyRequest"
178178
],
179179
"summary": "Create a copy request",
180-
"operationId": "create_request_v1_request_copy__project_geid__post",
180+
"operationId": "create_request_v1_request_copy__project_code__post",
181181
"parameters": [
182182
{
183183
"required": true,
184184
"schema": {
185-
"title": "Project Geid",
185+
"title": "Project Code",
186186
"type": "string"
187187
},
188-
"name": "project_geid",
188+
"name": "project_code",
189189
"in": "path"
190190
}
191191
],
@@ -223,21 +223,21 @@
223223
}
224224
}
225225
},
226-
"/v1/request/copy/{project_geid}/files": {
226+
"/v1/request/copy/{project_code}/files": {
227227
"get": {
228228
"tags": [
229229
"CopyRequest"
230230
],
231231
"summary": "List request files",
232-
"operationId": "list_request_files_v1_request_copy__project_geid__files_get",
232+
"operationId": "list_request_files_v1_request_copy__project_code__files_get",
233233
"parameters": [
234234
{
235235
"required": true,
236236
"schema": {
237-
"title": "Project Geid",
237+
"title": "Project Code",
238238
"type": "string"
239239
},
240-
"name": "project_geid",
240+
"name": "project_code",
241241
"in": "path"
242242
},
243243
{
@@ -293,11 +293,11 @@
293293
{
294294
"required": false,
295295
"schema": {
296-
"title": "Parent Geid",
296+
"title": "Parent Id",
297297
"type": "string",
298298
"default": ""
299299
},
300-
"name": "parent_geid",
300+
"name": "parent_id",
301301
"in": "query"
302302
},
303303
{
@@ -349,15 +349,15 @@
349349
"CopyRequest"
350350
],
351351
"summary": "Approve all files and trigger copy pipeline",
352-
"operationId": "review_all_files_v1_request_copy__project_geid__files_put",
352+
"operationId": "review_all_files_v1_request_copy__project_code__files_put",
353353
"parameters": [
354354
{
355355
"required": true,
356356
"schema": {
357-
"title": "Project Geid",
357+
"title": "Project Code",
358358
"type": "string"
359359
},
360-
"name": "project_geid",
360+
"name": "project_code",
361361
"in": "path"
362362
}
363363
],
@@ -399,15 +399,15 @@
399399
"CopyRequest"
400400
],
401401
"summary": "Approve files and trigger copy pipeline",
402-
"operationId": "review_files_v1_request_copy__project_geid__files_patch",
402+
"operationId": "review_files_v1_request_copy__project_code__files_patch",
403403
"parameters": [
404404
{
405405
"required": true,
406406
"schema": {
407-
"title": "Project Geid",
407+
"title": "Project Code",
408408
"type": "string"
409409
},
410-
"name": "project_geid",
410+
"name": "project_code",
411411
"in": "path"
412412
}
413413
],
@@ -445,21 +445,21 @@
445445
}
446446
}
447447
},
448-
"/v1/request/copy/{project_geid}/pending-files": {
448+
"/v1/request/copy/{project_code}/pending-files": {
449449
"get": {
450450
"tags": [
451451
"CopyRequest"
452452
],
453453
"summary": "Get pending count",
454-
"operationId": "get_pending_v1_request_copy__project_geid__pending_files_get",
454+
"operationId": "get_pending_v1_request_copy__project_code__pending_files_get",
455455
"parameters": [
456456
{
457457
"required": true,
458458
"schema": {
459-
"title": "Project Geid",
459+
"title": "Project Code",
460460
"type": "string"
461461
},
462-
"name": "project_geid",
462+
"name": "project_code",
463463
"in": "path"
464464
},
465465
{
@@ -497,21 +497,21 @@
497497
}
498498
}
499499
},
500-
"/v1/request/copy/{project_geid}/delete/{request_id}": {
500+
"/v1/request/copy/{project_code}/delete/{request_id}": {
501501
"delete": {
502502
"tags": [
503503
"CopyRequest"
504504
],
505505
"summary": "Delete Request",
506-
"operationId": "delete_request_v1_request_copy__project_geid__delete__request_id__delete",
506+
"operationId": "delete_request_v1_request_copy__project_code__delete__request_id__delete",
507507
"parameters": [
508508
{
509509
"required": true,
510510
"schema": {
511-
"title": "Project Geid",
511+
"title": "Project Code",
512512
"type": "string"
513513
},
514-
"name": "project_geid",
514+
"name": "project_code",
515515
"in": "path"
516516
},
517517
{
@@ -724,16 +724,16 @@
724724
"PATCHRequestFiles": {
725725
"title": "PATCHRequestFiles",
726726
"required": [
727-
"entity_geids",
727+
"entity_ids",
728728
"request_id",
729729
"review_status",
730730
"username",
731731
"session_id"
732732
],
733733
"type": "object",
734734
"properties": {
735-
"entity_geids": {
736-
"title": "Entity Geids",
735+
"entity_ids": {
736+
"title": "Entity Ids",
737737
"type": "array",
738738
"items": {
739739
"type": "string"
@@ -761,27 +761,27 @@
761761
"POSTRequest": {
762762
"title": "POSTRequest",
763763
"required": [
764-
"entity_geids",
765-
"destination_geid",
766-
"source_geid",
764+
"entity_ids",
765+
"destination_id",
766+
"source_id",
767767
"note",
768768
"submitted_by"
769769
],
770770
"type": "object",
771771
"properties": {
772-
"entity_geids": {
773-
"title": "Entity Geids",
772+
"entity_ids": {
773+
"title": "Entity Ids",
774774
"type": "array",
775775
"items": {
776776
"type": "string"
777777
}
778778
},
779-
"destination_geid": {
780-
"title": "Destination Geid",
779+
"destination_id": {
780+
"title": "Destination Id",
781781
"type": "string"
782782
},
783-
"source_geid": {
784-
"title": "Source Geid",
783+
"source_id": {
784+
"title": "Source Id",
785785
"type": "string"
786786
},
787787
"note": {

0 commit comments

Comments
 (0)