diff --git a/api-service/postman-collection/updated_v2_collection.json b/api-service/postman-collection/updated_v2_collection.json index 45dc3ac3..b673ccfb 100644 --- a/api-service/postman-collection/updated_v2_collection.json +++ b/api-service/postman-collection/updated_v2_collection.json @@ -1,10 +1,9 @@ { "info": { - "_postman_id": "99bdb8d0-6d3a-4ba2-9044-ec5263e54c95", + "_postman_id": "51471244-e9b6-453e-964d-dccbdac80e72", "name": "V2 docs", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", - "_exporter_id": "33916975", - "_collection_link": "https://speeding-star-177775.postman.co/workspace/sanketika-obsrv~2ce96556-12e2-48bd-8e42-9c1dba428cc8/collection/33916975-99bdb8d0-6d3a-4ba2-9044-ec5263e54c95?action=share&source=collection_link&creator=33916975" + "_exporter_id": "37164806" }, "item": [ { @@ -2255,6 +2254,290 @@ ] } ] + }, + { + "name": "Connector api's", + "item": [ + { + "name": "Connector list", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\"\n },\n \"request\": {\n \"filters\": {\n \"status\": [\n \"Draft\"\n ]\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "response": [ + { + "name": "Success: Filtered based on category", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6dc\"\n },\n \"request\": {\n \"filters\": {\n \"category\":[\n \"Database\"\n ]\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-Powered-By", + "value": "Express" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "1908" + }, + { + "key": "ETag", + "value": "W/\"774-58gfxDsxY66h3KZnTg62QbkxcPY\"" + }, + { + "key": "Date", + "value": "Tue, 30 Jul 2024 09:37:42 GMT" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Keep-Alive", + "value": "timeout=5" + } + ], + "cookie": [], + "body": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-07-30T15:07:42+05:30\",\n \"params\": {\n \"status\": \"SUCCESS\",\n \"msgid\": \"abc\",\n \"resmsgid\": \"632d3342-fd8a-47f7-afbb-96402a00b92f\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"data\": [\n {\n \"id\": \"aws-s3-connector-0.1.0\",\n \"connector_id\": \"aws-s3-connector\",\n \"name\": \"AWS S3\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The AWS S3 Connector is used to move data from any S3 Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.237Z\",\n \"updated_date\": \"2024-06-25T04:39:21.237Z\"\n },\n {\n \"id\": \"azure-blob-connector-0.1.0\",\n \"connector_id\": \"azure-blob-connector\",\n \"name\": \"Azure Blob Store\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The Azure Blob Store Connector is used to move data from any Azure Blob Container to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.302Z\",\n \"updated_date\": \"2024-06-25T04:39:21.302Z\"\n },\n {\n \"id\": \"gcs-connector-0.1.0\",\n \"connector_id\": \"gcs-connector\",\n \"name\": \"Google Cloud Storage\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The GCS Connector is used to move data from any Google Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.364Z\",\n \"updated_date\": \"2024-06-25T04:39:21.364Z\"\n }\n ],\n \"count\": 3\n }\n}" + }, + { + "name": "Failure: Invalid request body, filter option array should not be empty", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\"\n },\n \"request\": {\n \"filters\": {\n \"category\":[\n \"File\"\n ],\n \"status\": [\n //\"Live\"\n ]\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-Powered-By", + "value": "Express" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "399" + }, + { + "key": "ETag", + "value": "W/\"18f-Hsau3RTrCuWgbSoS3cqIWuUq45k\"" + }, + { + "key": "Date", + "value": "Tue, 30 Jul 2024 09:43:14 GMT" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Keep-Alive", + "value": "timeout=5" + } + ], + "cookie": [], + "body": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-07-30T15:13:14+05:30\",\n \"params\": {\n \"status\": \"FAILED\",\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\",\n \"resmsgid\": \"02fadde0-8c59-4420-8ab3-56474b01670b\"\n },\n \"responseCode\": \"BAD_REQUEST\",\n \"result\": {},\n \"error\": {\n \"code\": \"CONNECTORS_LIST_INPUT_INVALID\",\n \"message\": \"#properties/request/properties/filters/properties/status/minItems must NOT have fewer than 1 items\"\n }\n}" + }, + { + "name": "Success: Connectors list with all filter options", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\"\n },\n \"request\": {\n \"filters\": {\n \"category\":[\n \"File\",\"Database\"\n ],\n \"status\": [\n \"Live\",\"Draft\",\"InValidation\", \"Retired\"\n ]\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-Powered-By", + "value": "Express" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "4107" + }, + { + "key": "ETag", + "value": "W/\"100b-SEJt8xn1TwmZz8DKpFAwkYx6E8s\"" + }, + { + "key": "Date", + "value": "Tue, 30 Jul 2024 09:47:51 GMT" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Keep-Alive", + "value": "timeout=5" + } + ], + "cookie": [], + "body": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-07-30T15:17:51+05:30\",\n \"params\": {\n \"status\": \"SUCCESS\",\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\",\n \"resmsgid\": \"fffa3ee0-da12-4bea-9b72-365571a62a4e\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"data\": [\n {\n \"id\": \"postgres-connector-1.0.0\",\n \"connector_id\": \"postgres-connector\",\n \"name\": \"PostgreSQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The PostgreSQL Connector is used to move data from any Postgres Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.732Z\",\n \"updated_date\": \"2024-06-25T04:38:28.732Z\"\n },\n {\n \"id\": \"mysql-connector-1.0.0\",\n \"connector_id\": \"mysql-connector\",\n \"name\": \"MySQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The MySQL Connector is used to move data from any MySQL Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/en/6/62/MySQL.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.834Z\",\n \"updated_date\": \"2024-06-25T04:38:28.834Z\"\n },\n {\n \"id\": \"oracle-connector-1.0.0\",\n \"connector_id\": \"oracle-connector\",\n \"name\": \"Oracle\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The Oracle Connector is used to move data from any Oracle Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/5/50/Oracle_logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.840Z\",\n \"updated_date\": \"2024-06-25T04:38:28.840Z\"\n },\n {\n \"id\": \"mssql-connector-1.0.0\",\n \"connector_id\": \"mssql-connector\",\n \"name\": \"MS SQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The MS SQL Connector is used to move data from any MS SQL Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/2/29/Microsoft_SQL_Server_Logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.847Z\",\n \"updated_date\": \"2024-06-25T04:38:28.847Z\"\n },\n {\n \"id\": \"aws-s3-connector-0.1.0\",\n \"connector_id\": \"aws-s3-connector\",\n \"name\": \"AWS S3\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The AWS S3 Connector is used to move data from any S3 Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.237Z\",\n \"updated_date\": \"2024-06-25T04:39:21.237Z\"\n },\n {\n \"id\": \"azure-blob-connector-0.1.0\",\n \"connector_id\": \"azure-blob-connector\",\n \"name\": \"Azure Blob Store\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The Azure Blob Store Connector is used to move data from any Azure Blob Container to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.302Z\",\n \"updated_date\": \"2024-06-25T04:39:21.302Z\"\n },\n {\n \"id\": \"gcs-connector-0.1.0\",\n \"connector_id\": \"gcs-connector\",\n \"name\": \"Google Cloud Storage\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The GCS Connector is used to move data from any Google Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.364Z\",\n \"updated_date\": \"2024-06-25T04:39:21.364Z\"\n }\n ],\n \"count\": 7\n }\n}" + }, + { + "name": "Success: Connectors list without filters", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\"\n },\n \"request\": {\n // \"filters\": {\n // \"category\":[\n // \"File\",\"Database\"\n // ],\n // \"status\": [\n // \"Live\",\"Draft\",\"InValidation\", \"Retired\"\n // ]\n // }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-Powered-By", + "value": "Express" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "4107" + }, + { + "key": "ETag", + "value": "W/\"100b-N8mD4H5+SlIOmnNcq6Fnlq2pwXs\"" + }, + { + "key": "Date", + "value": "Tue, 30 Jul 2024 09:50:11 GMT" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Keep-Alive", + "value": "timeout=5" + } + ], + "cookie": [], + "body": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-07-30T15:20:11+05:30\",\n \"params\": {\n \"status\": \"SUCCESS\",\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\",\n \"resmsgid\": \"2c527a46-7bfe-4c74-a290-4dcf1a3c5f10\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"data\": [\n {\n \"id\": \"postgres-connector-1.0.0\",\n \"connector_id\": \"postgres-connector\",\n \"name\": \"PostgreSQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The PostgreSQL Connector is used to move data from any Postgres Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.732Z\",\n \"updated_date\": \"2024-06-25T04:38:28.732Z\"\n },\n {\n \"id\": \"mysql-connector-1.0.0\",\n \"connector_id\": \"mysql-connector\",\n \"name\": \"MySQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The MySQL Connector is used to move data from any MySQL Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/en/6/62/MySQL.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.834Z\",\n \"updated_date\": \"2024-06-25T04:38:28.834Z\"\n },\n {\n \"id\": \"oracle-connector-1.0.0\",\n \"connector_id\": \"oracle-connector\",\n \"name\": \"Oracle\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The Oracle Connector is used to move data from any Oracle Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/5/50/Oracle_logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.840Z\",\n \"updated_date\": \"2024-06-25T04:38:28.840Z\"\n },\n {\n \"id\": \"mssql-connector-1.0.0\",\n \"connector_id\": \"mssql-connector\",\n \"name\": \"MS SQL\",\n \"type\": \"source\",\n \"category\": \"Database\",\n \"version\": \"1.0.0\",\n \"description\": \"The MS SQL Connector is used to move data from any MS SQL Table to the Obsrv platform\",\n \"technology\": \"scala\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/2/29/Microsoft_SQL_Server_Logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:38:28.847Z\",\n \"updated_date\": \"2024-06-25T04:38:28.847Z\"\n },\n {\n \"id\": \"aws-s3-connector-0.1.0\",\n \"connector_id\": \"aws-s3-connector\",\n \"name\": \"AWS S3\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The AWS S3 Connector is used to move data from any S3 Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.237Z\",\n \"updated_date\": \"2024-06-25T04:39:21.237Z\"\n },\n {\n \"id\": \"azure-blob-connector-0.1.0\",\n \"connector_id\": \"azure-blob-connector\",\n \"name\": \"Azure Blob Store\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The Azure Blob Store Connector is used to move data from any Azure Blob Container to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.302Z\",\n \"updated_date\": \"2024-06-25T04:39:21.302Z\"\n },\n {\n \"id\": \"gcs-connector-0.1.0\",\n \"connector_id\": \"gcs-connector\",\n \"name\": \"Google Cloud Storage\",\n \"type\": \"source\",\n \"category\": \"File\",\n \"version\": \"0.1.0\",\n \"description\": \"The GCS Connector is used to move data from any Google Bucket to the Obsrv platform\",\n \"technology\": \"python\",\n \"runtime\": \"spark\",\n \"licence\": \"MIT\",\n \"owner\": \"Sunbird\",\n \"iconurl\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png\",\n \"status\": \"Live\",\n \"created_by\": \"SYSTEM\",\n \"updated_by\": \"SYSTEM\",\n \"created_date\": \"2024-06-25T04:39:21.364Z\",\n \"updated_date\": \"2024-06-25T04:39:21.364Z\"\n }\n ],\n \"count\": 7\n }\n}" + }, + { + "name": "Success: Filtered based on status", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-04-10T16:10:50+05:30\",\n \"params\": {\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\"\n },\n \"request\": {\n \"filters\": {\n \"status\": [\n \"Draft\"\n ]\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "http://localhost:3000/v2/connectors/list" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "X-Powered-By", + "value": "Express" + }, + { + "key": "Content-Type", + "value": "application/json; charset=utf-8" + }, + { + "key": "Content-Length", + "value": "250" + }, + { + "key": "ETag", + "value": "W/\"fa-+eWKIfUxsWBGuJy23qSucgLXke4\"" + }, + { + "key": "Date", + "value": "Tue, 30 Jul 2024 09:55:51 GMT" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "Keep-Alive", + "value": "timeout=5" + } + ], + "cookie": [], + "body": "{\n \"id\": \"api.connectors.list\",\n \"ver\": \"v2\",\n \"ts\": \"2024-07-30T15:25:51+05:30\",\n \"params\": {\n \"status\": \"SUCCESS\",\n \"msgid\": \"4a7f14c3-d61e-4d4f-be78-181834eeff6d\",\n \"resmsgid\": \"f506e725-eed4-41df-86dc-2477d5c4d19a\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"data\": [],\n \"count\": 0\n }\n}" + } + ] + } + ] } ] } \ No newline at end of file diff --git a/api-service/swagger-doc/v2_updated_doc_openapi.yml b/api-service/swagger-doc/v2_updated_doc_openapi.yml index ea2a663c..48400bff 100644 --- a/api-service/swagger-doc/v2_updated_doc_openapi.yml +++ b/api-service/swagger-doc/v2_updated_doc_openapi.yml @@ -4140,4 +4140,485 @@ paths: message: >- #properties/request/properties/access/enum must be equal to one of the allowed values - trace: '' \ No newline at end of file + trace: '' + /v2/connectors/list: + post: + tags: + - Connector api's + summary: Connector list + requestBody: + content: + application/json: + examples: + example1: + summary: Filter based on category + value: + id: api.connectors.list + ver: v2 + ts: '2024-04-10T16:10:50+05:30' + params: + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + request: + filters: + category: + - Database + example2: + summary: Connectors list with all filter options + value: + id: api.connectors.list + ver: v2 + ts: '2024-04-10T16:10:50+05:30' + params: + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + request: + filters: + category: + - Database, File + status: + - Live, Draft, InValidation, Retired + example3: + summary: Connectors list without filters + value: + id: api.connectors.list + ver: v2 + ts: '2024-04-10T16:10:50+05:30' + params: + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + request: {} + example4: + summary: Filtered based on status + value: + id: api.connectors.list + ver: v2 + ts: '2024-04-10T16:10:50+05:30' + params: + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + request: + filters: + status: + - Draft + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + examples: + example-0: + summary: 'Success: Filtered based on category' + value: + id: api.connectors.list + ver: v2 + ts: '2024-07-30T15:07:42+05:30' + params: + status: SUCCESS + msgid: abc + resmsgid: 632d3342-fd8a-47f7-afbb-96402a00b92f + responseCode: OK + result: + data: + - id: aws-s3-connector-0.1.0 + connector_id: aws-s3-connector + name: AWS S3 + type: source + category: File + version: 0.1.0 + description: >- + The AWS S3 Connector is used to move data from any + S3 Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.237Z' + updated_date: '2024-06-25T04:39:21.237Z' + - id: azure-blob-connector-0.1.0 + connector_id: azure-blob-connector + name: Azure Blob Store + type: source + category: File + version: 0.1.0 + description: >- + The Azure Blob Store Connector is used to move data + from any Azure Blob Container to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.302Z' + updated_date: '2024-06-25T04:39:21.302Z' + - id: gcs-connector-0.1.0 + connector_id: gcs-connector + name: Google Cloud Storage + type: source + category: File + version: 0.1.0 + description: >- + The GCS Connector is used to move data from any + Google Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.364Z' + updated_date: '2024-06-25T04:39:21.364Z' + count: 3 + example-1: + summary: 'Success: Connectors list with all filter options' + value: + id: api.connectors.list + ver: v2 + ts: '2024-07-30T15:17:51+05:30' + params: + status: SUCCESS + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + resmsgid: fffa3ee0-da12-4bea-9b72-365571a62a4e + responseCode: OK + result: + data: + - id: postgres-connector-1.0.0 + connector_id: postgres-connector + name: PostgreSQL + type: source + category: Database + version: 1.0.0 + description: >- + The PostgreSQL Connector is used to move data from + any Postgres Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.732Z' + updated_date: '2024-06-25T04:38:28.732Z' + - id: mysql-connector-1.0.0 + connector_id: mysql-connector + name: MySQL + type: source + category: Database + version: 1.0.0 + description: >- + The MySQL Connector is used to move data from any + MySQL Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/en/6/62/MySQL.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.834Z' + updated_date: '2024-06-25T04:38:28.834Z' + - id: oracle-connector-1.0.0 + connector_id: oracle-connector + name: Oracle + type: source + category: Database + version: 1.0.0 + description: >- + The Oracle Connector is used to move data from any + Oracle Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/5/50/Oracle_logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.840Z' + updated_date: '2024-06-25T04:38:28.840Z' + - id: mssql-connector-1.0.0 + connector_id: mssql-connector + name: MS SQL + type: source + category: Database + version: 1.0.0 + description: >- + The MS SQL Connector is used to move data from any + MS SQL Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/2/29/Microsoft_SQL_Server_Logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.847Z' + updated_date: '2024-06-25T04:38:28.847Z' + - id: aws-s3-connector-0.1.0 + connector_id: aws-s3-connector + name: AWS S3 + type: source + category: File + version: 0.1.0 + description: >- + The AWS S3 Connector is used to move data from any + S3 Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.237Z' + updated_date: '2024-06-25T04:39:21.237Z' + - id: azure-blob-connector-0.1.0 + connector_id: azure-blob-connector + name: Azure Blob Store + type: source + category: File + version: 0.1.0 + description: >- + The Azure Blob Store Connector is used to move data + from any Azure Blob Container to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.302Z' + updated_date: '2024-06-25T04:39:21.302Z' + - id: gcs-connector-0.1.0 + connector_id: gcs-connector + name: Google Cloud Storage + type: source + category: File + version: 0.1.0 + description: >- + The GCS Connector is used to move data from any + Google Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.364Z' + updated_date: '2024-06-25T04:39:21.364Z' + count: 7 + example-2: + summary: 'Success: Connectors list without filters' + value: + id: api.connectors.list + ver: v2 + ts: '2024-07-30T15:20:11+05:30' + params: + status: SUCCESS + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + resmsgid: 2c527a46-7bfe-4c74-a290-4dcf1a3c5f10 + responseCode: OK + result: + data: + - id: postgres-connector-1.0.0 + connector_id: postgres-connector + name: PostgreSQL + type: source + category: Database + version: 1.0.0 + description: >- + The PostgreSQL Connector is used to move data from + any Postgres Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.732Z' + updated_date: '2024-06-25T04:38:28.732Z' + - id: mysql-connector-1.0.0 + connector_id: mysql-connector + name: MySQL + type: source + category: Database + version: 1.0.0 + description: >- + The MySQL Connector is used to move data from any + MySQL Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/en/6/62/MySQL.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.834Z' + updated_date: '2024-06-25T04:38:28.834Z' + - id: oracle-connector-1.0.0 + connector_id: oracle-connector + name: Oracle + type: source + category: Database + version: 1.0.0 + description: >- + The Oracle Connector is used to move data from any + Oracle Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/5/50/Oracle_logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.840Z' + updated_date: '2024-06-25T04:38:28.840Z' + - id: mssql-connector-1.0.0 + connector_id: mssql-connector + name: MS SQL + type: source + category: Database + version: 1.0.0 + description: >- + The MS SQL Connector is used to move data from any + MS SQL Table to the Obsrv platform + technology: scala + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/2/29/Microsoft_SQL_Server_Logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:38:28.847Z' + updated_date: '2024-06-25T04:38:28.847Z' + - id: aws-s3-connector-0.1.0 + connector_id: aws-s3-connector + name: AWS S3 + type: source + category: File + version: 0.1.0 + description: >- + The AWS S3 Connector is used to move data from any + S3 Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/b/bc/Amazon-S3-Logo.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.237Z' + updated_date: '2024-06-25T04:39:21.237Z' + - id: azure-blob-connector-0.1.0 + connector_id: azure-blob-connector + name: Azure Blob Store + type: source + category: File + version: 0.1.0 + description: >- + The Azure Blob Store Connector is used to move data + from any Azure Blob Container to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/f/fa/Microsoft_Azure.svg + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.302Z' + updated_date: '2024-06-25T04:39:21.302Z' + - id: gcs-connector-0.1.0 + connector_id: gcs-connector + name: Google Cloud Storage + type: source + category: File + version: 0.1.0 + description: >- + The GCS Connector is used to move data from any + Google Bucket to the Obsrv platform + technology: python + runtime: spark + licence: MIT + owner: Sunbird + iconurl: >- + https://upload.wikimedia.org/wikipedia/commons/thumb/5/51/Google_Cloud_logo.svg/512px-Google_Cloud_logo.svg.png + status: Live + created_by: SYSTEM + updated_by: SYSTEM + created_date: '2024-06-25T04:39:21.364Z' + updated_date: '2024-06-25T04:39:21.364Z' + count: 7 + example-3: + summary: 'Success: Filtered based on status' + value: + id: api.connectors.list + ver: v2 + ts: '2024-07-30T15:25:51+05:30' + params: + status: SUCCESS + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + resmsgid: f506e725-eed4-41df-86dc-2477d5c4d19a + responseCode: OK + result: + data: [] + count: 0 + '400': + description: Bad Request + content: + application/json: + schema: + type: object + example: + id: api.connectors.list + ver: v2 + ts: '2024-07-30T15:13:14+05:30' + params: + status: FAILED + msgid: 4a7f14c3-d61e-4d4f-be78-181834eeff6d + resmsgid: 02fadde0-8c59-4420-8ab3-56474b01670b + responseCode: BAD_REQUEST + result: {} + error: + code: CONNECTORS_LIST_INPUT_INVALID + message: >- + #properties/request/properties/filters/properties/status/minItems + must NOT have fewer than 1 items \ No newline at end of file