Skip to content

Commit 426a43c

Browse files
mmaville-mdbmmaville-mdb
authored
v1-10-OpenAPI-Update (#172)
* v1-10-OpenAPI-Update * Updating OpenAPI Spec with final from release build. * Updating release date.
1 parent 3966545 commit 426a43c

File tree

2 files changed

+228
-17
lines changed

2 files changed

+228
-17
lines changed

‎source/release-notes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Release Notes
1414
1.10.0 Changelog
1515
----------------
1616

17-
*Released October 4, 2024*
17+
*Released October 2, 2024*
1818

1919
New features:
2020

‎source/rm-openapi-latest.json

Lines changed: 227 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"description": "OpenAPI specification for MongoDB Relational Migrator tool",
88
"title": "MongoDB Relational Migrator REST API",
9-
"version": "1.9.0"
9+
"version": "1.10.0"
1010
},
1111
"servers": [
1212
{
@@ -524,6 +524,137 @@
524524
]
525525
}
526526
},
527+
"/project/{projectId}/queries/bulk-convert": {
528+
"delete": {
529+
"operationId": "stopBulkQueryConversion",
530+
"description": "Stop a running bulk query conversion job",
531+
"parameters": [
532+
{
533+
"name": "projectId",
534+
"in": "path",
535+
"description": "Project ID",
536+
"required": true,
537+
"schema": {
538+
"$ref": "#/components/schemas/id"
539+
}
540+
}
541+
],
542+
"responses": {
543+
"200": {
544+
"description": "OK",
545+
"content": {
546+
"application/json": {
547+
"schema": {
548+
"$ref": "#/components/schemas/bulk-query-conversion-info"
549+
}
550+
}
551+
}
552+
},
553+
"404": {
554+
"description": "Not found",
555+
"content": {
556+
"application/json": {
557+
"schema": {
558+
"$ref": "#/components/schemas/error-response"
559+
}
560+
}
561+
}
562+
}
563+
},
564+
"tags": [
565+
"Query"
566+
]
567+
},
568+
"get": {
569+
"operationId": "getBulkQueryConversion",
570+
"description": "Get the status of a bulk query conversion job",
571+
"parameters": [
572+
{
573+
"name": "projectId",
574+
"in": "path",
575+
"description": "Project ID",
576+
"required": true,
577+
"schema": {
578+
"$ref": "#/components/schemas/id"
579+
}
580+
}
581+
],
582+
"responses": {
583+
"200": {
584+
"description": "OK",
585+
"content": {
586+
"application/json": {
587+
"schema": {
588+
"$ref": "#/components/schemas/bulk-query-conversion-info"
589+
}
590+
}
591+
}
592+
},
593+
"404": {
594+
"description": "Not found",
595+
"content": {
596+
"application/json": {
597+
"schema": {
598+
"$ref": "#/components/schemas/error-response"
599+
}
600+
}
601+
}
602+
}
603+
},
604+
"tags": [
605+
"Query"
606+
]
607+
},
608+
"post": {
609+
"operationId": "createBulkQueryConversion",
610+
"description": "Create a bulk query conversion job",
611+
"parameters": [
612+
{
613+
"name": "projectId",
614+
"in": "path",
615+
"description": "Project ID",
616+
"required": true,
617+
"schema": {
618+
"$ref": "#/components/schemas/id"
619+
}
620+
}
621+
],
622+
"requestBody": {
623+
"content": {
624+
"application/json": {
625+
"schema": {
626+
"$ref": "#/components/schemas/bulk-query-conversion-request"
627+
}
628+
}
629+
}
630+
},
631+
"responses": {
632+
"200": {
633+
"description": "OK",
634+
"content": {
635+
"application/json": {
636+
"schema": {
637+
"$ref": "#/components/schemas/bulk-query-conversion-info"
638+
}
639+
}
640+
}
641+
},
642+
"497": {
643+
"description": "Operation is not allowed when there are existing query conversions jobs",
644+
"content": {
645+
"application/json": {
646+
"schema": {
647+
"$ref": "#/components/schemas/error-response"
648+
}
649+
}
650+
}
651+
}
652+
},
653+
"tags": [
654+
"Query"
655+
]
656+
}
657+
},
527658
"/project/{projectId}/queries/{queryId}": {
528659
"delete": {
529660
"operationId": "deleteQuery",
@@ -561,6 +692,16 @@
561692
}
562693
}
563694
}
695+
},
696+
"497": {
697+
"description": "Operation is not allowed when there are existing query conversions jobs",
698+
"content": {
699+
"application/json": {
700+
"schema": {
701+
"$ref": "#/components/schemas/error-response"
702+
}
703+
}
704+
}
564705
}
565706
},
566707
"tags": [
@@ -679,6 +820,16 @@
679820
}
680821
}
681822
}
823+
},
824+
"497": {
825+
"description": "Operation is not allowed when there are existing query conversions jobs",
826+
"content": {
827+
"application/json": {
828+
"schema": {
829+
"$ref": "#/components/schemas/error-response"
830+
}
831+
}
832+
}
682833
}
683834
},
684835
"tags": [
@@ -689,6 +840,10 @@
689840
},
690841
"components": {
691842
"schemas": {
843+
"id": {
844+
"type": "string",
845+
"pattern": "^[A-Za-z0-9\\-]+$"
846+
},
692847
"error-response": {
693848
"type": "object",
694849
"properties": {
@@ -712,10 +867,6 @@
712867
"timestamp"
713868
]
714869
},
715-
"id": {
716-
"type": "string",
717-
"pattern": "^[A-Za-z0-9\\-]+$"
718-
},
719870
"jdbc-connection-details": {
720871
"type": "object",
721872
"properties": {
@@ -733,6 +884,12 @@
733884
},
734885
"password": {
735886
"type": "string"
887+
},
888+
"savePassword": {
889+
"type": "boolean"
890+
},
891+
"existingConnectionId": {
892+
"type": "string"
736893
}
737894
},
738895
"additionalProperties": false,
@@ -754,6 +911,9 @@
754911
"description": "Atlas projectId",
755912
"type": "string"
756913
},
914+
"savePassword": {
915+
"type": "boolean"
916+
},
757917
"projectName": {
758918
"description": "Atlas project name",
759919
"type": "string"
@@ -765,6 +925,9 @@
765925
"hasTimeSeriesCollection": {
766926
"type": "boolean",
767927
"default": false
928+
},
929+
"existingConnectionId": {
930+
"type": "string"
768931
}
769932
},
770933
"additionalProperties": false,
@@ -1076,6 +1239,61 @@
10761239
"projectId"
10771240
]
10781241
},
1242+
"bulk-query-conversion-info": {
1243+
"type": "object",
1244+
"properties": {
1245+
"pendingQueries": {
1246+
"type": "array",
1247+
"items": {
1248+
"type": "string"
1249+
}
1250+
},
1251+
"runningQueries": {
1252+
"type": "array",
1253+
"items": {
1254+
"type": "string"
1255+
}
1256+
},
1257+
"completedQueries": {
1258+
"type": "array",
1259+
"items": {
1260+
"type": "string"
1261+
}
1262+
},
1263+
"failedQueries": {
1264+
"type": "array",
1265+
"items": {
1266+
"type": "string"
1267+
}
1268+
}
1269+
},
1270+
"additionalProperties": false,
1271+
"required": [
1272+
"completedQueries",
1273+
"failedQueries",
1274+
"pendingQueries",
1275+
"runningQueries"
1276+
]
1277+
},
1278+
"bulk-query-conversion-request": {
1279+
"type": "object",
1280+
"properties": {
1281+
"language": {
1282+
"$ref": "#/components/schemas/convert-query-language-type"
1283+
},
1284+
"queries": {
1285+
"type": "array",
1286+
"items": {
1287+
"type": "string"
1288+
}
1289+
}
1290+
},
1291+
"additionalProperties": false,
1292+
"required": [
1293+
"language",
1294+
"queries"
1295+
]
1296+
},
10791297
"query-details-response": {
10801298
"type": "object",
10811299
"properties": {
@@ -1179,15 +1397,7 @@
11791397
]
11801398
},
11811399
"database-type": {
1182-
"type": "string",
1183-
"enum": [
1184-
"ORACLE",
1185-
"SQL_SERVER",
1186-
"MYSQL",
1187-
"POSTGRESQL",
1188-
"DB2",
1189-
"SYBASE"
1190-
]
1400+
"type": "string"
11911401
},
11921402
"migration-job-descriptor-options": {
11931403
"type": "object",
@@ -1411,7 +1621,8 @@
14111621
"NOT_STARTED",
14121622
"RUNNING",
14131623
"FAILED",
1414-
"COMPLETED"
1624+
"COMPLETED",
1625+
"PENDING"
14151626
]
14161627
},
14171628
"convert-query-language-type": {
@@ -1725,4 +1936,4 @@
17251936
"name": "Query"
17261937
}
17271938
]
1728-
}
1939+
}

0 commit comments

Comments
 (0)