diff --git a/docsfera.json b/docsfera.json index 350903a..eb4af4e 100644 --- a/docsfera.json +++ b/docsfera.json @@ -5071,6 +5071,65 @@ ] } }, + "/platform/pipelines/{pipelineId}/pipeline_run/{runId}/jobs": { + "get": { + "operationId": "PlatformApiController_getPipelineRunJobs", + "summary": "Get pipeline run jobs", + "description": "Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.", + "parameters": [ + { + "name": "pipelineId", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "runId", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "DB-backed job runs for the selected pipeline run.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jobs": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "jobs" + ] + } + } + } + } + }, + "tags": [ + "Platform API" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, "/platform/jobs/{jobId}/input": { "put": { "operationId": "PlatformApiController_updateJobInput", @@ -6104,6 +6163,48 @@ ] } }, + "/catalog/custom-properties": { + "get": { + "operationId": "CatalogController_getCustomPropertyDefinitions", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, "/catalog/data-asset/{id}": { "get": { "operationId": "CatalogController_getDataAsset", @@ -6364,6 +6465,57 @@ "access-token": [] } ] + }, + "patch": { + "operationId": "CatalogController_updateColumnsMetadata", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateColumnsMetadataRequest" + } + } + } + }, + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] } }, "/catalog/data-asset/{id}/preview": { @@ -7842,6 +7994,94 @@ ] } }, + "/connection-test/refresh-catalog": { + "post": { + "operationId": "ConnectionTestController_refreshCatalog", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshCatalogReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshCatalogRes" + } + } + } + }, + "202": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshCatalogRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/connection-test/refresh-catalog/status": { + "post": { + "operationId": "ConnectionTestController_refreshCatalogStatus", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshCatalogStatusReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RefreshCatalogRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, "/oauth/hubspot": { "get": { "operationId": "OauthController_oauthHubspot", @@ -11715,6 +11955,35 @@ "columns_metadata" ] }, + "ColumnDescriptionDto": { + "type": "object", + "properties": { + "column_name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "column_name", + "description" + ] + }, + "UpdateColumnsMetadataRequest": { + "type": "object", + "properties": { + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnDescriptionDto" + } + } + }, + "required": [ + "columns" + ] + }, "IData": { "type": "object", "properties": { @@ -11817,6 +12086,37 @@ "docs" ] }, + "CustomPropertyDto": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "text", + "number", + "date", + "boolean" + ] + }, + "color": { + "type": "string" + }, + "emoji": { + "type": "string" + } + }, + "required": [ + "key", + "value", + "type" + ] + }, "IUpdateDataRequest": { "type": "object", "properties": { @@ -11845,6 +12145,12 @@ }, "docs": { "type": "string" + }, + "custom_properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPropertyDto" + } } }, "required": [ @@ -12299,11 +12605,15 @@ }, "type": { "type": "string" + }, + "is_primary_key": { + "type": "boolean" } }, "required": [ "name", - "type" + "type", + "is_primary_key" ] }, "TableMetadataDto": { @@ -12405,6 +12715,85 @@ "checks" ] }, + "RefreshCatalogReq": { + "type": "object", + "properties": { + "connection_id": { + "type": "string" + }, + "plugin": { + "type": "string", + "enum": [ + "oracle", + "mysql", + "postgresql", + "sqlserver", + "mysql_cdc", + "postgresql_cdc", + "oracle_cdc" + ] + } + }, + "required": [ + "connection_id", + "plugin" + ] + }, + "RefreshCatalogRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "session_id": { + "type": "string" + }, + "date": { + "type": "string" + } + }, + "required": [ + "operation_result", + "status", + "session_id", + "date" + ] + }, + "RefreshCatalogStatusReq": { + "type": "object", + "properties": { + "connection_id": { + "type": "string" + }, + "plugin": { + "type": "string", + "enum": [ + "oracle", + "mysql", + "postgresql", + "sqlserver", + "mysql_cdc", + "postgresql_cdc", + "oracle_cdc" + ] + }, + "session_id": { + "type": "string" + }, + "date": { + "type": "string" + } + }, + "required": [ + "connection_id", + "plugin", + "session_id", + "date" + ] + }, "INote": { "type": "object", "properties": { diff --git a/src/modules/connection-test/dto/connection-test.ts b/src/modules/connection-test/dto/connection-test.ts index cb10c4c..20447b9 100644 --- a/src/modules/connection-test/dto/connection-test.ts +++ b/src/modules/connection-test/dto/connection-test.ts @@ -176,8 +176,26 @@ export class RefreshCatalogReq { @IsString() connection_id: string; - @ApiProperty({ enum: ['oracle', 'mysql', 'postgresql', 'sqlserver'] }) - @IsIn(['oracle', 'mysql', 'postgresql', 'sqlserver']) + @ApiProperty({ + enum: [ + 'oracle', + 'mysql', + 'postgresql', + 'sqlserver', + 'mysql_cdc', + 'postgresql_cdc', + 'oracle_cdc', + ], + }) + @IsIn([ + 'oracle', + 'mysql', + 'postgresql', + 'sqlserver', + 'mysql_cdc', + 'postgresql_cdc', + 'oracle_cdc', + ]) plugin: string; }