diff --git a/docsfera.external.json b/docsfera.external.json new file mode 100644 index 0000000..1fdca24 --- /dev/null +++ b/docsfera.external.json @@ -0,0 +1,3227 @@ +{ + "service": "${DOCS_API_TOKEN}", + "pageId": "${DOCS_PAGE_ID}", + "blockId": "${DOCS_BLOCK_ID}", + "schema": { + "openapi": "3.0.0", + "paths": { + "/auth/sign-in": { + "post": { + "operationId": "AuthController_signIn", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuthSignInReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuthSignInRes" + } + } + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/auth/refresh-access-token": { + "post": { + "operationId": "AuthController_refreshAccessToken", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuthRefreshAccessTokenReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuthRefreshAccessTokenRes" + } + } + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/connections": { + "post": { + "operationId": "ConnectionController_createConnection", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateConnectionDto" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionRes" + } + } + } + } + }, + "tags": [ + "connections" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "get": { + "operationId": "ConnectionController_getAllConnections", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionsRes" + } + } + } + } + }, + "tags": [ + "connections" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connections/{id}": { + "put": { + "operationId": "ConnectionController_updateConnection", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateConnectionDto" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionRes" + } + } + } + } + }, + "tags": [ + "connections" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "delete": { + "operationId": "ConnectionController_deleteConnection", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionRes" + } + } + } + } + }, + "tags": [ + "connections" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "get": { + "operationId": "ConnectionController_getConnectionDetails", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionDetailsRes" + } + } + } + } + }, + "tags": [ + "connections" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/network-config": { + "get": { + "operationId": "NetworkConfigController_findAllNetworkConfigs", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FindAllNetworkConfigsRes" + } + } + } + } + }, + "tags": [ + "Network Config" + ], + "security": [ + { + "access-token": [] + } + ] + }, + "post": { + "operationId": "NetworkConfigController_createNetworkConfigs", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/CreateNetworkConfigReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNetworkConfigRes" + } + } + } + }, + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateNetworkConfigRes" + } + } + } + } + }, + "tags": [ + "Network Config" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/network-config/{id}": { + "get": { + "operationId": "NetworkConfigController_findNetworkConfigById", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FindAllNetworkConfigsRes" + } + } + } + } + }, + "tags": [ + "Network Config" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/network-config/{id}/details": { + "get": { + "operationId": "NetworkConfigController_findNetworkConfigByIdDetails", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FindAllNetworkConfigsRes" + } + } + } + } + }, + "tags": [ + "Network Config" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/inputs": { + "post": { + "operationId": "InputsController_create", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateInputReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Input" + } + } + } + }, + "201": { + "description": "" + } + }, + "tags": [ + "Inputs" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/inputs/{id}": { + "get": { + "operationId": "InputsController_findOne", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Inputs" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2": { + "post": { + "operationId": "PipelinesController_create", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ICreatePipelineV2Req" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPipelineV2" + } + } + } + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + }, + "get": { + "operationId": "PipelinesController_findAll", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2/download-logs": { + "get": { + "operationId": "PipelinesController_downloadLogs", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + }, + { + "name": "pipeline_run_id", + "required": true, + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2/{id}/config": { + "get": { + "operationId": "PipelinesController_getPipelineproperties", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2/{id}/objects": { + "get": { + "operationId": "PipelinesController_getPipelineObjects", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2/{id}/status": { + "get": { + "operationId": "PipelinesController_getPipelineStatus", + "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": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/pipelinesV2/{id}": { + "get": { + "operationId": "PipelinesController_findOne", + "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": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + }, + "patch": { + "operationId": "PipelinesController_update", + "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": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + }, + "delete": { + "operationId": "PipelinesController_delete", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "" + } + }, + "tags": [ + "PipelinesV2" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/catalog": { + "get": { + "operationId": "CatalogController_searchCatalog", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + }, + { + "name": "sort_by", + "required": false, + "in": "query", + "description": "Data Asset field to sort", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "required": false, + "in": "query", + "description": "Tipo de ordenação - asc: crescente; desc: decrescente ", + "schema": { + "default": "asc", + "enum": [ + "asc", + "desc" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ICatalogAllResponse" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "post": { + "operationId": "CatalogController_createDataAsset", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ICreateDataAsset" + } + } + } + }, + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/catalog/data-asset/{id}": { + "get": { + "operationId": "CatalogController_getDataAsset", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + }, + { + "name": "shared", + "required": true, + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "put": { + "operationId": "CatalogController_updateDataAsset", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IUpdateDataRequest" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IOneDataAsset" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "delete": { + "operationId": "CatalogController_deleteDataAsset", + "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" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/catalog/data-asset/{id}/columns-metadata": { + "get": { + "operationId": "CatalogController_getDataAssetColumnsMetadata", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IColumnsMetadataResponse" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/catalog/data-asset/{id}/preview": { + "get": { + "operationId": "CatalogController_getDataAssetPreview", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IPreviewResponse" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/catalog/data-asset/{id}/docs": { + "get": { + "operationId": "CatalogController_getDataAssetDocs", + "parameters": [ + { + "name": "dadosfera-lang", + "in": "header", + "required": false, + "schema": { + "enum": [ + "pt-br", + "en-us" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IDocsResponse" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "post": { + "operationId": "CatalogController_manageDataAssetDocs", + "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" + } + } + ], + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/catalog/data-asset/{id}/comment": { + "post": { + "operationId": "CatalogController_commentOnDataAsset", + "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/IMakeAComment" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + }, + "delete": { + "operationId": "CatalogController_deleteComment", + "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/IDeleteComment" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Catalog" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/connection-test/ping": { + "post": { + "operationId": "ConnectionTestController_connectionTestPing", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestPingReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestPingRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/credentials": { + "post": { + "operationId": "ConnectionTestController_connectionTestCredentials", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestCredentialsReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestCredentialsRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/schemas": { + "post": { + "operationId": "ConnectionTestController_connectionTestListSchemas", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListSchemasReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListSchemasRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/tables": { + "post": { + "operationId": "ConnectionTestController_connectionTestListTables", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListTablesReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListTablesRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/table-metadata": { + "post": { + "operationId": "ConnectionTestController_getTableMetadata", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTableMetadataReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTableMetadataRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/oauth/hubspot": { + "get": { + "operationId": "OauthController_oauthHubspot", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/oauth/googleads": { + "get": { + "operationId": "OauthController_oauthGoogleAds", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/oauth/google-sheets": { + "get": { + "operationId": "OauthController_oauthGoogleSheets", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/oauth/facebook": { + "get": { + "operationId": "OauthController_oauthFacebook", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/oauth/mailchimp": { + "get": { + "operationId": "OauthController_oauthMailchimp", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/oauth/salesforce": { + "get": { + "operationId": "OauthController_oauthSalesforce", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "boolean" + } + } + } + } + }, + "tags": [ + "oauth" + ] + } + }, + "/health": { + "get": { + "operationId": "HealthController_check", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Health" + ] + } + } + }, + "info": { + "title": "Maestro - feat/docs-refactor", + "description": "This is the Maestro API", + "version": "1.0.0", + "contact": {} + }, + "tags": [], + "servers": [], + "components": { + "securitySchemes": { + "access-token": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemas": { + "AuthSignInReq": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "totp": { + "type": "string", + "description": "TOTP code used to login when Multi-Factor Authentication is enabled" + } + }, + "required": [ + "username", + "password" + ] + }, + "AuthCustomer": { + "type": "object", + "properties": { + "modules": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "tier": { + "type": "string" + }, + "scheduleLimit": { + "type": "string" + } + }, + "required": [ + "modules", + "id", + "name", + "tier", + "scheduleLimit" + ] + }, + "AuthUser": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "username": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "username", + "createdAt" + ] + }, + "AuthTokens": { + "type": "object", + "properties": { + "accessToken": { + "type": "string" + }, + "refreshToken": { + "type": "string" + }, + "termsOfUseToken": { + "type": "string" + }, + "idToken": { + "type": "string", + "deprecated": true + } + }, + "required": [ + "accessToken", + "refreshToken", + "idToken" + ] + }, + "TermsOfUse": { + "type": "object", + "properties": { + "version": { + "type": "number" + }, + "publicUrl": { + "type": "string" + }, + "enforceDate": { + "type": "string" + }, + "createdAt": { + "type": "string" + } + }, + "required": [ + "version", + "publicUrl", + "enforceDate", + "createdAt" + ] + }, + "TermsOfUseStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "pending", + "required", + "ok" + ] + }, + "lastSigned": { + "$ref": "#/components/schemas/TermsOfUse" + }, + "next": { + "$ref": "#/components/schemas/TermsOfUse" + } + }, + "required": [ + "status" + ] + }, + "AuthSignInRes": { + "type": "object", + "properties": { + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "mfaStatus": { + "type": "string", + "enum": [ + "pending", + "none", + "totp" + ] + }, + "customer": { + "$ref": "#/components/schemas/AuthCustomer" + }, + "user": { + "$ref": "#/components/schemas/AuthUser" + }, + "tokens": { + "$ref": "#/components/schemas/AuthTokens" + }, + "termsOfUse": { + "$ref": "#/components/schemas/TermsOfUseStatus" + } + }, + "required": [ + "permissions", + "mfaStatus" + ] + }, + "AuthRefreshAccessTokenReq": { + "type": "object", + "properties": { + "refreshToken": { + "type": "string" + }, + "customerName": { + "type": "string" + } + }, + "required": [ + "refreshToken", + "customerName" + ] + }, + "AuthRefreshAccessTokenRes": { + "type": "object", + "properties": { + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "accessToken": { + "type": "string" + } + }, + "required": [ + "permissions", + "accessToken" + ] + }, + "CreateConnectionDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "properties": { + "type": "object" + }, + "connector_id": { + "type": "string" + }, + "connector_name": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "image_url": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "type", + "properties", + "connector_id", + "connector_name", + "plugin", + "image_url" + ] + }, + "ConnectionToCatalogDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "connector_id": { + "type": "string" + }, + "connector_name": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "image_url": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "type", + "connector_id", + "connector_name", + "plugin", + "image_url" + ] + }, + "ConnectionRes": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/components/schemas/ConnectionToCatalogDto" + }, + "message": { + "type": "string" + } + }, + "required": [ + "connection", + "message" + ] + }, + "UpdateConnectionDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "properties": { + "type": "object" + } + }, + "required": [ + "name", + "description", + "properties" + ] + }, + "ConnectionsRes": { + "type": "object", + "properties": { + "connections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConnectionToCatalogDto" + } + }, + "message": { + "type": "string" + } + }, + "required": [ + "connections", + "message" + ] + }, + "ConnectionDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "customer_id": { + "type": "string" + }, + "customer_name": { + "type": "string" + }, + "user_id": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "pipelines": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "properties": { + "type": "object" + }, + "connector_id": { + "type": "string" + }, + "connector_name": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "image_url": { + "type": "string" + } + }, + "required": [ + "id", + "customer_id", + "customer_name", + "user_id", + "updated_at", + "created_at", + "pipelines", + "name", + "description", + "type", + "properties", + "connector_id", + "connector_name", + "plugin", + "image_url" + ] + }, + "ConnectionDetailsRes": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/components/schemas/ConnectionDto" + }, + "message": { + "type": "string" + } + }, + "required": [ + "connection", + "message" + ] + }, + "NetworkConfigToCatalogDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "customer_id": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "network_type_id": { + "type": "string" + }, + "network_type_name": { + "type": "string" + } + }, + "required": [ + "id", + "customer_id", + "plugin", + "type", + "name", + "description", + "created_at", + "updated_at", + "network_type_id", + "network_type_name" + ] + }, + "FindAllNetworkConfigsRes": { + "type": "object", + "properties": { + "network_configs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NetworkConfigToCatalogDto" + } + }, + "message": { + "type": "string" + } + }, + "required": [ + "network_configs", + "message" + ] + }, + "CreateNetworkConfigReq": { + "type": "object", + "properties": { + "network_type_id": { + "type": "string" + }, + "network_type_name": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ovpn_file": { + "type": "string", + "format": "binary" + } + }, + "required": [ + "network_type_id", + "network_type_name", + "name", + "description", + "ovpn_file" + ] + }, + "CreateNetworkConfigRes": { + "type": "object", + "properties": { + "network_config": { + "$ref": "#/components/schemas/NetworkConfigToCatalogDto" + } + }, + "required": [ + "network_config" + ] + }, + "TableColumns": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "columns": { + "type": "array", + "items": { + "type": "string" + } + }, + "references": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "columns", + "references", + "type" + ] + }, + "CreateInputReq": { + "type": "object", + "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TableColumns" + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "tables", + "name", + "description", + "plugin" + ] + }, + "Input": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TableColumns" + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "tables", + "name", + "description", + "plugin", + "created_at", + "updated_at" + ] + }, + "ICreatePipelineV2Req": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "connection_id": { + "type": "string" + }, + "cron": { + "type": "string" + }, + "input_id": { + "type": "string" + }, + "transformations_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "object" + }, + "connector_name": { + "type": "string" + }, + "connector_plugin": { + "type": "string" + }, + "connector_version": { + "type": "string" + }, + "image_url": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "connection_id", + "cron", + "connector_name", + "connector_plugin", + "connector_version", + "image_url" + ] + }, + "IPipelineV2": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "connection_id": { + "type": "string" + }, + "cron": { + "type": "string" + }, + "input_id": { + "type": "string" + }, + "transformations_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "type": "object" + }, + "connector_name": { + "type": "string" + }, + "connector_plugin": { + "type": "string" + }, + "connector_version": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "description", + "connection_id", + "cron", + "connector_name", + "connector_plugin", + "connector_version", + "image_url", + "created_at", + "updated_at" + ] + }, + "IRole": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "name", + "id" + ] + }, + "IUser": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "username", + "id" + ] + }, + "IComment": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "message": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "id", + "message", + "created_at", + "username" + ] + }, + "EmbedObject": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "IDataAsset": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "database_name": { + "type": "string" + }, + "table_name": { + "type": "string" + }, + "num_columns": { + "type": "number" + }, + "location": { + "type": "string" + }, + "created_time": { + "type": "string" + }, + "table_type": { + "type": "string" + }, + "size_in_bytes": { + "type": "number" + }, + "num_files": { + "type": "number" + }, + "data_encrypted": { + "type": "string" + }, + "num_rows": { + "type": "number" + }, + "display_name": { + "type": "string" + }, + "pipeline_id": { + "type": "string" + }, + "user_id": { + "type": "string" + }, + "description": { + "type": "string" + }, + "data_asset_type": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "owner": { + "type": "string" + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IRole" + } + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IUser" + } + }, + "dashboard_id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "type": "string" + } + }, + "embedding_params": { + "type": "object" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IComment" + } + }, + "embed": { + "$ref": "#/components/schemas/EmbedObject" + }, + "share_type": { + "type": "string", + "enum": [ + "none", + "public", + "private" + ] + } + }, + "required": [ + "id", + "display_name", + "pipeline_id", + "user_id", + "description", + "data_asset_type", + "tags", + "owner", + "roles", + "users", + "created_at", + "comments" + ] + }, + "ICatalogAllResponse": { + "type": "object", + "properties": { + "data_assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IDataAsset" + } + }, + "total": { + "type": "number" + } + }, + "required": [ + "data_assets", + "total" + ] + }, + "IColumnMetadata": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "table_name": { + "type": "string" + }, + "column_name": { + "type": "string" + }, + "data_type": { + "type": "string" + }, + "missing_count": { + "type": "string" + }, + "min": { + "type": "string" + }, + "max": { + "type": "string" + }, + "count": { + "type": "string" + }, + "histogram": { + "type": "string" + }, + "mean": { + "type": "string" + }, + "median": { + "type": "string" + }, + "missing_rate": { + "type": "string" + }, + "stddev": { + "type": "string" + }, + "unique_count": { + "type": "string" + }, + "unique_rate": { + "type": "string" + }, + "analyzer_rules": { + "type": "array", + "items": { + "type": "string" + } + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "table_name", + "column_name", + "data_type", + "missing_count", + "min", + "max", + "count", + "histogram", + "mean", + "median", + "missing_rate", + "stddev", + "unique_count", + "unique_rate", + "analyzer_rules", + "version" + ] + }, + "IColumnsMetadataResponse": { + "type": "object", + "properties": { + "columns_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IColumnMetadata" + } + } + }, + "required": [ + "columns_metadata" + ] + }, + "IData": { + "type": "object", + "properties": { + "var": { + "type": "number" + }, + "date": { + "type": "string" + }, + "last": { + "type": "number" + }, + "maximum": { + "type": "number" + }, + "minimum": { + "type": "number" + }, + "day_opening": { + "type": "number" + } + }, + "required": [ + "var", + "date", + "last", + "maximum", + "minimum", + "day_opening" + ] + }, + "IPreview": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "database_name": { + "type": "string" + }, + "table_name": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IData" + } + } + }, + "required": [ + "id", + "database_name", + "table_name", + "data" + ] + }, + "IPreviewResponse": { + "type": "object", + "properties": { + "preview": { + "$ref": "#/components/schemas/IPreview" + } + }, + "required": [ + "preview" + ] + }, + "IDocs": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "docs": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "table_id": { + "type": "string" + } + }, + "required": [ + "id", + "docs", + "updated_at", + "table_id" + ] + }, + "IDocsResponse": { + "type": "object", + "properties": { + "docs": { + "$ref": "#/components/schemas/IDocs" + } + }, + "required": [ + "docs" + ] + }, + "IUpdateDataRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "embed": { + "$ref": "#/components/schemas/EmbedObject" + }, + "share_type": { + "type": "string", + "enum": [ + "none", + "public", + "private" + ] + } + }, + "required": [ + "name", + "description", + "tags" + ] + }, + "IOneDataAsset": { + "type": "object", + "properties": { + "data_asset": { + "$ref": "#/components/schemas/IDataAsset" + } + }, + "required": [ + "data_asset" + ] + }, + "ICreateDataAsset": { + "type": "object", + "properties": { + "display_name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "data_asset_type": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "location": { + "type": "string" + }, + "embed": { + "$ref": "#/components/schemas/EmbedObject" + } + }, + "required": [ + "display_name", + "description", + "data_asset_type", + "external_url", + "location" + ] + }, + "IMakeAComment": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + }, + "required": [ + "message" + ] + }, + "CommentToDelete": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "username": { + "type": "string" + } + }, + "required": [ + "id", + "username" + ] + }, + "IDeleteComment": { + "type": "object", + "properties": { + "comment": { + "$ref": "#/components/schemas/CommentToDelete" + } + }, + "required": [ + "comment" + ] + }, + "ConnectionTestPingReq": { + "type": "object", + "properties": { + "plugin": { + "type": "string" + }, + "host": { + "type": "string" + }, + "port": { + "type": "number" + }, + "network_config_id": { + "type": "string" + }, + "connection_id": { + "type": "string" + } + } + }, + "ConnectionTestPingRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + } + }, + "required": [ + "operation_result" + ] + }, + "ConnectionTestCredentialsProperties": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "database": { + "type": "string" + } + }, + "required": [ + "host", + "port", + "username", + "password", + "database" + ] + }, + "ConnectionTestCredentialsReq": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "connector_id": { + "type": "string" + }, + "connector_name": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/ConnectionTestCredentialsProperties" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "type", + "connector_id", + "connector_name", + "plugin", + "image_url", + "properties" + ] + }, + "ConnectionTestCredentialsRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "operation_result", + "connection_id" + ] + }, + "ConnectionTestListSchemasReq": { + "type": "object", + "properties": { + "plugin": { + "type": "string" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "plugin", + "connection_id" + ] + }, + "ConnectionTestListSchemasRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "schema_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "operation_result", + "schema_list" + ] + }, + "ConnectionTestListTablesReq": { + "type": "object", + "properties": { + "plugin": { + "type": "string" + }, + "connection_id": { + "type": "string" + }, + "schema": { + "type": "string" + } + }, + "required": [ + "plugin", + "connection_id", + "schema" + ] + }, + "ConnectionTestListTablesRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "table_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "operation_result", + "table_list" + ] + }, + "GetTableMetadataReq": { + "type": "object", + "properties": { + "connection_id": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "schema": { + "type": "string" + }, + "table_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "connection_id", + "plugin", + "schema", + "table_list" + ] + }, + "ColumnDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "TableMetadataDto": { + "type": "object", + "properties": { + "table_name": { + "type": "string" + }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnDto" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnDto" + } + } + }, + "required": [ + "table_name", + "columns", + "references" + ] + }, + "GetTableMetadataRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "tables_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TableMetadataDto" + } + } + }, + "required": [ + "operation_result", + "tables_metadata" + ] + } + } + } + } +} \ No newline at end of file diff --git a/docsfera.json b/docsfera.json index 60424aa..1fdca24 100644 --- a/docsfera.json +++ b/docsfera.json @@ -49,45 +49,6 @@ ] } }, - "/auth/sso/snowflake": { - "post": { - "operationId": "AuthController_snowflakeSignIn", - "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": [ - "Auth" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, "/auth/refresh-access-token": { "post": { "operationId": "AuthController_refreshAccessToken", @@ -132,935 +93,6 @@ ] } }, - "/auth/change-password": { - "post": { - "operationId": "AuthController_changePassword", - "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": [ - "Auth" - ] - } - }, - "/auth/reset-password": { - "post": { - "operationId": "AuthController_resetPassword", - "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": [ - "Auth" - ] - } - }, - "/auth/verify-reset-password-code": { - "post": { - "operationId": "AuthController_verifyResetPasswordCode", - "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": [ - "Auth" - ] - } - }, - "/auth/confirm-reset-password": { - "post": { - "operationId": "AuthController_confirmResetPassword", - "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": [ - "Auth" - ] - } - }, - "/auth/enable-totp": { - "post": { - "operationId": "AuthController_enableTotpMFA", - "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": [ - "Auth" - ] - } - }, - "/auth/disable-totp": { - "post": { - "operationId": "AuthController_disableTotpMFA", - "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": [ - "Auth" - ] - } - }, - "/auth/dismiss-totp": { - "post": { - "operationId": "AuthController_dismissTotpMFA", - "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": [ - "Auth" - ] - } - }, - "/auth/verify-totp": { - "post": { - "operationId": "AuthController_verifyTotp", - "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": [ - "Auth" - ] - } - }, - "/auth/verify-access-token": { - "get": { - "operationId": "AuthController_verifyAccessToken", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Auth" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/auth/session/{session}": { - "get": { - "operationId": "AuthController_getSession", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - }, - { - "name": "session", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Auth" - ] - } - }, - "/auth/oauth/google": { - "get": { - "operationId": "AuthController_googleOauth", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - } - }, - "tags": [ - "Auth" - ] - } - }, - "/auth/oauth/google/callback": { - "get": { - "operationId": "AuthController_googleOauthCallback", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Auth" - ] - } - }, - "/connectors": { - "post": { - "operationId": "ConnectorController_uploadConnector", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/CreateConnectorDto" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "get": { - "operationId": "ConnectorController_getAllConnectors", - "parameters": [ - { - "name": "search", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "language", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "size", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "page", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/uploads": { - "post": { - "operationId": "ConnectorController_uploadFile", - "parameters": [], - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/multiple-connectors-upload": { - "post": { - "operationId": "ConnectorController_uploadConnectorsFile", - "parameters": [], - "responses": { - "201": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/tags": { - "get": { - "operationId": "ConnectorController_getConnectorsTags", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/{plugin}": { - "get": { - "operationId": "ConnectorController_getConnector", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "put": { - "operationId": "ConnectorController_updateConnector", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/UpdateDto" - } - } - } - }, - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "ConnectorController_deleteConnector", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/{plugin}/details": { - "get": { - "operationId": "ConnectorController_getConnectorDetails", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/{plugin}/add-tag": { - "put": { - "operationId": "ConnectorController_addTagOnConnector", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTagDto" - } - } - } - }, - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/connectors/{plugin}/remove-tag": { - "put": { - "operationId": "ConnectorController_removeTagOnConnector", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RemoveTagDto" - } - } - } - }, - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "connectors" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/permissions": { - "get": { - "operationId": "PermissionsController_getPublicPermissions", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "description": "Defaults to pt-br", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetPublicPermissionsRes" - } - } - } - } - }, - "tags": [ - "Permissions" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/terms-of-use/token": { - "get": { - "operationId": "TermsOfUseController_getToken", - "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": [ - "TermsOfUse" - ] - } - }, - "/terms-of-use/accept": { - "post": { - "operationId": "TermsOfUseController_accept", - "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": [ - "TermsOfUse" - ] - } - }, "/connections": { "post": { "operationId": "ConnectionController_createConnection", @@ -1232,1179 +264,6 @@ ] } }, - "/users": { - "get": { - "operationId": "UsersController_getAllUsersByCustomerId", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllUsersByCustomerIdRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "post": { - "operationId": "UsersController_createUser", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUserReq" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUserRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/hierarchies": { - "get": { - "operationId": "UsersController_getAllHierarchies", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllHierarchiesRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/departments": { - "get": { - "operationId": "UsersController_getAllDepartments", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllDepartmentsRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/jobTitles": { - "get": { - "operationId": "UsersController_getAllJobTitles", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllDepartmentsRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/{id}": { - "get": { - "operationId": "UsersController_findOneById", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IUserByCustomer" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "UsersController_deleteUser", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteUserRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "patch": { - "operationId": "UsersController_updateUser", - "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/UpdateUserReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateUserRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/batch": { - "post": { - "operationId": "UsersController_batchCreateUser", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BatchCreateUserReq" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BatchCreateUserRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/{id}/resend-invite": { - "post": { - "operationId": "UsersController_resendInvite", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/role": { - "delete": { - "operationId": "UsersController_unassignRoleToUser", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - }, - { - "name": "userId", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "roleId", - "required": true, - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "put": { - "operationId": "UsersController_assignRoleToUser", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssignRoleToUserReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/roles": { - "patch": { - "operationId": "UsersController_setUserRoles", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetUserRolesReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetUserRolesRes" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/users/synchronize/{id}": { - "post": { - "operationId": "UsersController_synchronizeUser", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateUserRes" - } - } - } - }, - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/roles": { - "get": { - "operationId": "RolesController_searchRoles", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - }, - { - "name": "permissionId", - "required": false, - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "getUsers", - "required": false, - "in": "query", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - }, - { - "name": "canUntoggleLogic", - "required": false, - "in": "query", - "schema": { - "enum": [ - "data_assets_sharing" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetRolesByCustomerRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "post": { - "operationId": "RolesController_createRole", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRoleReq" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRoleRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/roles/permissions": { - "put": { - "operationId": "RolesController_grantPermissionsToRole", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GrantPermissionsToRoleReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GrantPermissionsToRoleRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "RolesController_revokePermissionsFromRole", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RevokePermissionsFromRoleReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RevokePermissionsFromRoleRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "patch": { - "operationId": "RolesController_setRolePermissions", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetRolePermissionsReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetRolePermissionsRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/roles/users": { - "patch": { - "operationId": "RolesController_setRoleUsers", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetRoleUsersReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetRoleUsersRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/roles/{id}": { - "get": { - "operationId": "RolesController_getRoleById", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoleDto" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "RolesController_deleteRole", - "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" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "patch": { - "operationId": "RolesController_updateRole", - "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/UpdateRoleReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateRoleRes" - } - } - } - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, "/network-config": { "get": { "operationId": "NetworkConfigController_findAllNetworkConfigs", @@ -2548,16 +407,16 @@ ] } }, - "/connection-test/ping": { + "/inputs": { "post": { - "operationId": "ConnectionTestController_connectionTestPing", + "operationId": "InputsController_create", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectionTestPingReq" + "$ref": "#/components/schemas/CreateInputReq" } } } @@ -2568,204 +427,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectionTestPingRes" + "$ref": "#/components/schemas/Input" } } } - } - }, - "tags": [ - "Connection Test" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/connection-test/credentials": { - "post": { - "operationId": "ConnectionTestController_connectionTestCredentials", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestCredentialsReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestCredentialsRes" - } - } - } - } - }, - "tags": [ - "Connection Test" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/connection-test/schemas": { - "post": { - "operationId": "ConnectionTestController_connectionTestListSchemas", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestListSchemasReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestListSchemasRes" - } - } - } - } - }, - "tags": [ - "Connection Test" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/connection-test/tables": { - "post": { - "operationId": "ConnectionTestController_connectionTestListTables", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestListTablesReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectionTestListTablesRes" - } - } - } - } - }, - "tags": [ - "Connection Test" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/connection-test/table-metadata": { - "post": { - "operationId": "ConnectionTestController_getTableMetadata", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetTableMetadataReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetTableMetadataRes" - } - } - } - } - }, - "tags": [ - "Connection Test" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/pipelines/start/{id}": { - "post": { - "operationId": "PipelinesController_activate", - "summary": "", - "deprecated": true, - "description": "This method is deprecated. Please use route /pipelinesV2/start/:id instead", - "parameters": [], - "responses": { + }, "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } + "description": "" } }, "tags": [ - "Pipelines" + "Inputs" ], "security": [ - { - "access-token": [] - }, { "access-token": [] } ] } }, - "/pipelines/{id}/status": { + "/inputs/{id}": { "get": { - "operationId": "PipelinesController_getPipelineStatus", - "summary": "", - "deprecated": true, - "description": "This method is deprecated. Please use route /pipelinesV2/:id/status instead", + "operationId": "InputsController_findOne", "parameters": [], "responses": { "200": { @@ -2780,12 +463,9 @@ } }, "tags": [ - "Pipelines" + "Inputs" ], "security": [ - { - "access-token": [] - }, { "access-token": [] } @@ -3089,46 +769,6 @@ } ] }, - "put": { - "operationId": "PipelinesController_updateDeprecated", - "summary": "", - "deprecated": true, - "description": "This method is deprecated. Please use PATCH instead", - "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": [ - "PipelinesV2" - ], - "security": [ - { - "access-token": [] - } - ] - }, "delete": { "operationId": "PipelinesController_delete", "parameters": [ @@ -3160,507 +800,6 @@ ] } }, - "/pipelinesV2/init-upload": { - "post": { - "operationId": "PipelinesController_initUploadFile", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IInitUploadCSVFile" - } - } - } - }, - "responses": { - "201": { - "description": "" - } - }, - "tags": [ - "PipelinesV2" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/pipelinesV2/complete-upload": { - "post": { - "operationId": "PipelinesController_completeUploadFile", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ICompleteUploadCSVFile" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "PipelinesV2" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/pipelinesV2/file": { - "post": { - "operationId": "PipelinesController_uploadedFile", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ICreatePipelineCSVFile" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "PipelinesV2" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/pipelinesV2/start/{id}": { - "post": { - "operationId": "PipelinesController_activate", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "PipelinesV2" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/inputs/available-entities/{plugin}": { - "get": { - "operationId": "InputsController_getAvailableEntities", - "parameters": [ - { - "name": "plugin", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAvailableEntitiesRes" - } - } - } - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/inputs": { - "post": { - "operationId": "InputsController_create", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateInputReq" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Input" - } - } - } - }, - "201": { - "description": "" - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "get": { - "operationId": "InputsController_findAll", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/inputs/{id}": { - "get": { - "operationId": "InputsController_findOne", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "patch": { - "operationId": "InputsController_update", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "InputsController_delete", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Inputs" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/transformations": { - "post": { - "operationId": "TransformationsController_create", - "parameters": [], - "responses": { - "201": { - "description": "" - } - }, - "tags": [ - "Transformations" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "get": { - "operationId": "TransformationsController_findAll", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Transformations" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/transformations/{id}": { - "get": { - "operationId": "TransformationsController_findOne", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Transformations" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "put": { - "operationId": "TransformationsController_update", - "parameters": [ - { - "name": "id", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Transformations" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - }, - "delete": { - "operationId": "TransformationsController_delete", - "parameters": [], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Transformations" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, - "/health": { - "get": { - "operationId": "HealthController_check", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Health" - ] - } - }, "/catalog": { "get": { "operationId": "CatalogController_searchCatalog", @@ -3769,80 +908,6 @@ ] } }, - "/catalog/data-asset": { - "get": { - "operationId": "CatalogController_findByPipelineAndObject", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Catalog" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/catalog/tags": { - "get": { - "operationId": "CatalogController_findAllTags", - "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", @@ -3984,41 +1049,6 @@ ] } }, - "/catalog/data-asset/rls/{id}": { - "get": { - "operationId": "CatalogController_getDataAssetRls", - "parameters": [ - { - "name": "dadosfera-lang", - "in": "header", - "required": false, - "schema": { - "enum": [ - "pt-br", - "en-us" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Catalog" - ], - "security": [ - { - "access-token": [] - }, - { - "access-token": [] - } - ] - } - }, "/catalog/data-asset/{id}/columns-metadata": { "get": { "operationId": "CatalogController_getDataAssetColumnsMetadata", @@ -4193,86 +1223,6 @@ ] } }, - "/catalog/data-asset/{id}/manage-permissions": { - "put": { - "operationId": "CatalogController_manageDataAssetPermissions", - "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" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Catalog" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/catalog/data-asset/{id}/revoke-permissions": { - "put": { - "operationId": "CatalogController_revokeDataAssetPermissions", - "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" - } - } - ], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "Catalog" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, "/catalog/data-asset/{id}/comment": { "post": { "operationId": "CatalogController_commentOnDataAsset", @@ -4391,6 +1341,186 @@ ] } }, + "/connection-test/ping": { + "post": { + "operationId": "ConnectionTestController_connectionTestPing", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestPingReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestPingRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/credentials": { + "post": { + "operationId": "ConnectionTestController_connectionTestCredentials", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestCredentialsReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestCredentialsRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/schemas": { + "post": { + "operationId": "ConnectionTestController_connectionTestListSchemas", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListSchemasReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListSchemasRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/tables": { + "post": { + "operationId": "ConnectionTestController_connectionTestListTables", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListTablesReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionTestListTablesRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/connection-test/table-metadata": { + "post": { + "operationId": "ConnectionTestController_getTableMetadata", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTableMetadataReq" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetTableMetadataRes" + } + } + } + } + }, + "tags": [ + "Connection Test" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, "/oauth/hubspot": { "get": { "operationId": "OauthController_oauthHubspot", @@ -4412,20 +1542,6 @@ ] } }, - "/oauth/hubspot/callback": { - "get": { - "operationId": "OauthController_oauthHubspotCallback", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "oauth" - ] - } - }, "/oauth/googleads": { "get": { "operationId": "OauthController_oauthGoogleAds", @@ -4447,20 +1563,6 @@ ] } }, - "/oauth/googleads/callback": { - "get": { - "operationId": "OauthController_oauthGoogleAdsCallback", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "oauth" - ] - } - }, "/oauth/google-sheets": { "get": { "operationId": "OauthController_oauthGoogleSheets", @@ -4482,20 +1584,6 @@ ] } }, - "/oauth/google-sheets/callback": { - "get": { - "operationId": "OauthController_oauthGoogleSheetsCallback", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "oauth" - ] - } - }, "/oauth/facebook": { "get": { "operationId": "OauthController_oauthFacebook", @@ -4517,20 +1605,6 @@ ] } }, - "/oauth/facebook/callback": { - "get": { - "operationId": "OauthController_oauthFacebookCallback", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "oauth" - ] - } - }, "/oauth/mailchimp": { "get": { "operationId": "OauthController_oauthMailchimp", @@ -4552,20 +1626,6 @@ ] } }, - "/oauth/mailchimp/callback": { - "get": { - "operationId": "OauthController_oauthMailchimpCallback", - "parameters": [], - "responses": { - "200": { - "description": "" - } - }, - "tags": [ - "oauth" - ] - } - }, "/oauth/salesforce": { "get": { "operationId": "OauthController_oauthSalesforce", @@ -4587,9 +1647,9 @@ ] } }, - "/oauth/salesforce/callback": { + "/health": { "get": { - "operationId": "OauthController_oauthSalesforceCallback", + "operationId": "HealthController_check", "parameters": [], "responses": { "200": { @@ -4597,59 +1657,7 @@ } }, "tags": [ - "oauth" - ] - } - }, - "/productboard/notes": { - "post": { - "operationId": "ProductboardController_sendNote", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/INote" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - } - }, - "tags": [ - "Productboard" - ], - "security": [ - { - "access-token": [] - } - ] - } - }, - "/trackEvent/{id}": { - "post": { - "operationId": "MixpanelController_trackEvent", - "parameters": [], - "responses": { - "201": { - "description": "" - } - }, - "security": [ - { - "access-token": [] - } + "Health" ] } } @@ -4879,137 +1887,6 @@ "accessToken" ] }, - "CreateConnectorDto": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "connector": { - "type": "string" - } - }, - "required": [ - "file", - "connector" - ] - }, - "UpdateDto": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - }, - "version": { - "type": "string" - }, - "category": { - "type": "string" - }, - "plugin": { - "type": "string" - }, - "image": { - "type": "string" - }, - "docs": { - "type": "string" - }, - "name": { - "type": "string" - }, - "options": { - "type": "object", - "description": "skip_select_entities: boolean skip_select_columns: boolean;" - }, - "connection_controls": { - "type": "array", - "items": { - "properties": {} - } - } - }, - "required": [ - "version" - ] - }, - "AddTagDto": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "RemoveTagDto": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "PermissionGroupPermission": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "number" - } - }, - "required": [ - "name", - "id" - ] - }, - "PermissionGroup": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionGroupPermission" - } - } - }, - "required": [ - "title", - "permissions" - ] - }, - "GetPublicPermissionsRes": { - "type": "object", - "properties": { - "permissionGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionGroup" - } - } - }, - "required": [ - "permissionGroups" - ] - }, "CreateConnectionDto": { "type": "object", "properties": { @@ -5230,844 +2107,6 @@ "message" ] }, - "PermissionDto": { - "type": "object", - "properties": { - "id": { - "type": "number" - }, - "seqid": { - "type": "number" - }, - "name": { - "type": "string" - }, - "claim": { - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - } - }, - "required": [ - "id", - "seqid", - "name", - "claim", - "createdAt", - "updatedAt" - ] - }, - "Customer": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "tier": { - "type": "string" - }, - "info": { - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "domain", - "tier", - "info", - "createdAt", - "updatedAt" - ] - }, - "UserRole": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionDto" - } - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "isPublic": { - "type": "boolean" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "usage": { - "type": "string" - }, - "canUntoggle": { - "type": "boolean", - "description": "Whether this role can be untoggled" - } - }, - "required": [ - "id", - "name", - "description", - "createdAt", - "updatedAt", - "isPublic", - "customer", - "usage" - ] - }, - "IUserByCustomer": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRole" - } - }, - "jobTitle": { - "type": "string" - }, - "department": { - "type": "string" - }, - "hierarchy": { - "type": "string" - }, - "mfaStatus": { - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "status": { - "type": "string" - }, - "lastLogin": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "name", - "email", - "roles", - "jobTitle", - "department", - "hierarchy", - "mfaStatus", - "createdAt", - "updatedAt", - "status" - ] - }, - "GetAllUsersByCustomerIdRes": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IUserByCustomer" - } - }, - "departments": { - "type": "array", - "items": { - "type": "string" - } - }, - "jobTitles": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "users", - "departments", - "jobTitles" - ] - }, - "Hierarchy": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name" - ] - }, - "GetAllHierarchiesRes": { - "type": "object", - "properties": { - "hierarchies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Hierarchy" - } - } - }, - "required": [ - "hierarchies" - ] - }, - "GetAllDepartmentsRes": { - "type": "object", - "properties": { - "departments": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "departments" - ] - }, - "CreateUserReq": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "roleNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "jobTitle": { - "type": "string" - }, - "department": { - "type": "string" - }, - "hierarchy": { - "type": "string" - } - }, - "required": [ - "email" - ] - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRole" - } - }, - "jobTitle": { - "type": "string" - }, - "department": { - "type": "string" - }, - "hierarchy": { - "type": "string" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "mfaStatus": { - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "status": { - "type": "string" - }, - "lastLogin": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "email", - "roles", - "jobTitle", - "department", - "hierarchy", - "mfaStatus", - "createdAt", - "updatedAt", - "status" - ] - }, - "CreateUserRes": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/User" - } - }, - "required": [ - "user" - ] - }, - "BatchCreateUserReq": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateUserReq" - } - } - }, - "required": [ - "users" - ] - }, - "ErrorUsers": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/CreateUserReq" - }, - "error": { - "type": "string" - } - }, - "required": [ - "user", - "error" - ] - }, - "BatchCreateUserRes": { - "type": "object", - "properties": { - "usersCreated": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - }, - "errorUsers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ErrorUsers" - } - } - }, - "required": [ - "usersCreated", - "errorUsers" - ] - }, - "DeleteUserRes": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "SetUserRolesReq": { - "type": "object", - "properties": { - "userId": { - "type": "string" - }, - "roleNames": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "userId", - "roleNames" - ] - }, - "SetUserRolesRes": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/IUserByCustomer" - } - }, - "required": [ - "user" - ] - }, - "AssignRoleToUserReq": { - "type": "object", - "properties": { - "userId": { - "type": "string" - }, - "roleId": { - "type": "string" - } - }, - "required": [ - "userId", - "roleId" - ] - }, - "UpdateUserReq": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "jobTitle": { - "type": "string" - }, - "department": { - "type": "string" - }, - "hierarchy": { - "type": "string" - }, - "roleNames": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "UpdateUserRes": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/IUserByCustomer" - } - }, - "required": [ - "user" - ] - }, - "UserNoRolesAndCustomer": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "jobTitle": { - "type": "string" - }, - "department": { - "type": "string" - }, - "hierarchy": { - "type": "string" - }, - "mfaStatus": { - "type": "string" - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "status": { - "type": "string" - }, - "lastLogin": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "email", - "jobTitle", - "department", - "hierarchy", - "mfaStatus", - "createdAt", - "updatedAt", - "status" - ] - }, - "RoleDto": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionDto" - } - }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserNoRolesAndCustomer" - } - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "isPublic": { - "type": "boolean" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "usage": { - "type": "string" - }, - "canUntoggle": { - "type": "boolean", - "description": "Whether this role can be untoggled" - } - }, - "required": [ - "id", - "name", - "description", - "createdAt", - "updatedAt", - "isPublic", - "customer", - "usage" - ] - }, - "GetRolesByCustomerRes": { - "type": "object", - "properties": { - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RoleDto" - } - } - }, - "required": [ - "roles" - ] - }, - "CreateRoleReq": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "permissionIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "userIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - } - }, - "required": [ - "name", - "permissionIds", - "description" - ] - }, - "CustomerRole": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PermissionDto" - } - }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserNoRolesAndCustomer" - } - }, - "createdAt": { - "type": "string" - }, - "updatedAt": { - "type": "string" - }, - "isPublic": { - "type": "boolean" - }, - "usage": { - "type": "string" - }, - "canUntoggle": { - "type": "boolean", - "description": "Whether this role can be untoggled" - } - }, - "required": [ - "id", - "name", - "description", - "createdAt", - "updatedAt", - "isPublic", - "usage" - ] - }, - "CreateRoleRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/CustomerRole" - } - }, - "required": [ - "role" - ] - }, - "GrantPermissionsToRoleReq": { - "type": "object", - "properties": { - "roleId": { - "type": "string" - }, - "permissionIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "roleId", - "permissionIds" - ] - }, - "GrantPermissionsToRoleRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/RoleDto" - } - }, - "required": [ - "role" - ] - }, - "RevokePermissionsFromRoleReq": { - "type": "object", - "properties": { - "roleId": { - "type": "string" - }, - "permissionIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "roleId", - "permissionIds" - ] - }, - "RevokePermissionsFromRoleRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/RoleDto" - } - }, - "required": [ - "role" - ] - }, - "SetRolePermissionsReq": { - "type": "object", - "properties": { - "roleId": { - "type": "string" - }, - "permissionIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "roleId", - "permissionIds" - ] - }, - "SetRolePermissionsRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/RoleDto" - } - }, - "required": [ - "role" - ] - }, - "SetRoleUsersReq": { - "type": "object", - "properties": { - "roleId": { - "type": "string" - }, - "userIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "roleId", - "userIds" - ] - }, - "SetRoleUsersRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/RoleDto" - } - }, - "required": [ - "role" - ] - }, - "UpdateRoleReq": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - } - }, - "UpdateRoleRes": { - "type": "object", - "properties": { - "role": { - "$ref": "#/components/schemas/RoleDto" - } - }, - "required": [ - "role" - ] - }, "NetworkConfigToCatalogDto": { "type": "object", "properties": { @@ -6172,276 +2211,103 @@ "network_config" ] }, - "ConnectionTestPingReq": { + "TableColumns": { "type": "object", "properties": { - "plugin": { + "name": { "type": "string" }, - "host": { - "type": "string" + "columns": { + "type": "array", + "items": { + "type": "string" + } }, - "port": { - "type": "number" + "references": { + "type": "array", + "items": { + "type": "string" + } }, - "network_config_id": { - "type": "string" - }, - "connection_id": { - "type": "string" - } - } - }, - "ConnectionTestPingRes": { - "type": "object", - "properties": { - "operation_result": { - "type": "boolean" - } - }, - "required": [ - "operation_result" - ] - }, - "ConnectionTestCredentialsProperties": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "database": { + "type": { "type": "string" } }, "required": [ - "host", - "port", - "username", - "password", - "database" + "name", + "columns", + "references", + "type" ] }, - "ConnectionTestCredentialsReq": { + "CreateInputReq": { "type": "object", "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TableColumns" + } + }, "name": { "type": "string" }, "description": { "type": "string" }, + "plugin": { + "type": "string" + }, "type": { "type": "string" - }, - "network_config_id": { - "type": "string" - }, - "connector_id": { - "type": "string" - }, - "connector_name": { - "type": "string" - }, - "plugin": { - "type": "string" - }, - "image_url": { - "type": "string" - }, - "properties": { - "$ref": "#/components/schemas/ConnectionTestCredentialsProperties" - }, - "connection_id": { - "type": "string" } }, "required": [ + "tables", "name", "description", - "type", - "connector_id", - "connector_name", - "plugin", - "image_url", - "properties" + "plugin" ] }, - "ConnectionTestCredentialsRes": { + "Input": { "type": "object", "properties": { - "operation_result": { - "type": "boolean" - }, - "connection_id": { - "type": "string" - } - }, - "required": [ - "operation_result", - "connection_id" - ] - }, - "ConnectionTestListSchemasReq": { - "type": "object", - "properties": { - "plugin": { + "id": { "type": "string" }, - "connection_id": { - "type": "string" - } - }, - "required": [ - "plugin", - "connection_id" - ] - }, - "ConnectionTestListSchemasRes": { - "type": "object", - "properties": { - "operation_result": { - "type": "boolean" - }, - "schema_list": { + "tables": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/TableColumns" } - } - }, - "required": [ - "operation_result", - "schema_list" - ] - }, - "ConnectionTestListTablesReq": { - "type": "object", - "properties": { - "plugin": { - "type": "string" }, - "connection_id": { - "type": "string" - }, - "schema": { - "type": "string" - } - }, - "required": [ - "plugin", - "connection_id", - "schema" - ] - }, - "ConnectionTestListTablesRes": { - "type": "object", - "properties": { - "operation_result": { - "type": "boolean" - }, - "table_list": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "operation_result", - "table_list" - ] - }, - "GetTableMetadataReq": { - "type": "object", - "properties": { - "connection_id": { - "type": "string" - }, - "plugin": { - "type": "string" - }, - "schema": { - "type": "string" - }, - "table_list": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "connection_id", - "plugin", - "schema", - "table_list" - ] - }, - "ColumnDto": { - "type": "object", - "properties": { "name": { "type": "string" }, + "description": { + "type": "string" + }, + "plugin": { + "type": "string" + }, "type": { "type": "string" - } - }, - "required": [ - "name", - "type" - ] - }, - "TableMetadataDto": { - "type": "object", - "properties": { - "table_name": { + }, + "created_at": { "type": "string" }, - "columns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ColumnDto" - } - }, - "references": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ColumnDto" - } + "updated_at": { + "type": "string" } }, "required": [ - "table_name", - "columns", - "references" - ] - }, - "GetTableMetadataRes": { - "type": "object", - "properties": { - "operation_result": { - "type": "boolean" - }, - "tables_metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TableMetadataDto" - } - } - }, - "required": [ - "operation_result", - "tables_metadata" + "id", + "tables", + "name", + "description", + "plugin", + "created_at", + "updated_at" ] }, "ICreatePipelineV2Req": { @@ -6570,205 +2436,6 @@ "updated_at" ] }, - "IInitUploadCSVFile": { - "type": "object", - "properties": { - "file_name": { - "type": "string" - }, - "parts": { - "type": "number" - } - }, - "required": [ - "file_name", - "parts" - ] - }, - "ICompleteUploadCSVFile": { - "type": "object", - "properties": { - "upload_id": { - "type": "string" - }, - "file_name": { - "type": "string" - }, - "parts": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "upload_id", - "file_name", - "parts" - ] - }, - "ICreatePipelineCSVFile": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "file_name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "encoding": { - "type": "string" - }, - "sep": { - "type": "string" - }, - "header": { - "type": "boolean" - } - }, - "required": [ - "name", - "file_name", - "description", - "encoding", - "sep", - "header" - ] - }, - "AvailableEntity": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "replication_methods": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "replication_methods" - ] - }, - "GetAvailableEntitiesRes": { - "type": "object", - "properties": { - "entities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AvailableEntity" - } - } - }, - "required": [ - "entities" - ] - }, - "TableColumns": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "columns": { - "type": "array", - "items": { - "type": "string" - } - }, - "references": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - } - }, - "required": [ - "name", - "columns", - "references", - "type" - ] - }, - "CreateInputReq": { - "type": "object", - "properties": { - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TableColumns" - } - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "plugin": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "tables", - "name", - "description", - "plugin" - ] - }, - "Input": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TableColumns" - } - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "plugin": { - "type": "string" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - }, - "required": [ - "id", - "tables", - "name", - "description", - "plugin", - "created_at", - "updated_at" - ] - }, "IRole": { "type": "object", "properties": { @@ -7282,16 +2949,146 @@ "comment" ] }, - "INote": { + "ConnectionTestPingReq": { "type": "object", "properties": { - "title": { + "plugin": { "type": "string" }, - "content": { + "host": { "type": "string" }, - "tags": { + "port": { + "type": "number" + }, + "network_config_id": { + "type": "string" + }, + "connection_id": { + "type": "string" + } + } + }, + "ConnectionTestPingRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + } + }, + "required": [ + "operation_result" + ] + }, + "ConnectionTestCredentialsProperties": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "database": { + "type": "string" + } + }, + "required": [ + "host", + "port", + "username", + "password", + "database" + ] + }, + "ConnectionTestCredentialsReq": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "network_config_id": { + "type": "string" + }, + "connector_id": { + "type": "string" + }, + "connector_name": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/ConnectionTestCredentialsProperties" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "name", + "description", + "type", + "connector_id", + "connector_name", + "plugin", + "image_url", + "properties" + ] + }, + "ConnectionTestCredentialsRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "operation_result", + "connection_id" + ] + }, + "ConnectionTestListSchemasReq": { + "type": "object", + "properties": { + "plugin": { + "type": "string" + }, + "connection_id": { + "type": "string" + } + }, + "required": [ + "plugin", + "connection_id" + ] + }, + "ConnectionTestListSchemasRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "schema_list": { "type": "array", "items": { "type": "string" @@ -7299,9 +3096,129 @@ } }, "required": [ - "title", - "content", - "tags" + "operation_result", + "schema_list" + ] + }, + "ConnectionTestListTablesReq": { + "type": "object", + "properties": { + "plugin": { + "type": "string" + }, + "connection_id": { + "type": "string" + }, + "schema": { + "type": "string" + } + }, + "required": [ + "plugin", + "connection_id", + "schema" + ] + }, + "ConnectionTestListTablesRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "table_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "operation_result", + "table_list" + ] + }, + "GetTableMetadataReq": { + "type": "object", + "properties": { + "connection_id": { + "type": "string" + }, + "plugin": { + "type": "string" + }, + "schema": { + "type": "string" + }, + "table_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "connection_id", + "plugin", + "schema", + "table_list" + ] + }, + "ColumnDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "TableMetadataDto": { + "type": "object", + "properties": { + "table_name": { + "type": "string" + }, + "columns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnDto" + } + }, + "references": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ColumnDto" + } + } + }, + "required": [ + "table_name", + "columns", + "references" + ] + }, + "GetTableMetadataRes": { + "type": "object", + "properties": { + "operation_result": { + "type": "boolean" + }, + "tables_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TableMetadataDto" + } + } + }, + "required": [ + "operation_result", + "tables_metadata" ] } } diff --git a/environment.d.ts b/environment.d.ts new file mode 100644 index 0000000..727c484 --- /dev/null +++ b/environment.d.ts @@ -0,0 +1,18 @@ +declare global { + namespace NodeJS { + interface ProcessEnv { + NODE_ENV: 'test'; + ENV: 'local' | 'stg' | 'prd' | 'test'; + LOCAL_ENV: 'stg' | 'prd'; + + DUC_URL: string; + INFACTORY_URL: string; + PIFACTORY_URL: string; + + INTERNAL_SWAGGER: 'true' | 'false'; + + AWS_REGION: string; + } + } +} +export {}; diff --git a/src/app.module.ts b/src/app.module.ts index d736888..22ea09a 100644 --- a/src/app.module.ts +++ b/src/app.module.ts @@ -40,24 +40,24 @@ import { MixpanelModule } from './modules/mixpanel/mixpanel.module'; isGlobal: true, }), AuthModule, + ConnectionModule, + NetworkConfigModule, + InputsModule, + PipelinesV2Module, + CatalogModule, ConnectorModule, PermissionsModule, TermsOfUseModule, - ConnectionModule, - NetworkConfigModule, ConnectionTestModule, PipelinesModule, - PipelinesV2Module, TransformationsModule, - HealthModule, - CatalogModule, UsersModule, RolesModule, - InputsModule, OauthModule, - CatalogModule, ProductboardModule, MixpanelModule, + //Always leave HealthModule last, so it is on the bottom of swagger + HealthModule, ], }) export class AppModule {} diff --git a/src/decorators/swagger.decorator.ts b/src/decorators/swagger.decorator.ts new file mode 100644 index 0000000..342eb69 --- /dev/null +++ b/src/decorators/swagger.decorator.ts @@ -0,0 +1,13 @@ +import { applyDecorators } from '@nestjs/common'; +import { ApiExcludeController, ApiExcludeEndpoint } from '@nestjs/swagger'; + +export function ApiInternalOnlyEndpoint() { + if (process.env.INTERNAL_SWAGGER !== 'true') + return applyDecorators(ApiExcludeEndpoint()); + return () => null; +} +export function ApiInternalOnlyController() { + if (process.env.INTERNAL_SWAGGER !== 'true') + return applyDecorators(ApiExcludeController()); + return () => null; +} diff --git a/src/main.ts b/src/main.ts index 1fe7ee5..12d4b73 100644 --- a/src/main.ts +++ b/src/main.ts @@ -14,7 +14,7 @@ async function bootstrap() { serviceEnvironment: process.env.ENV, }); const logger = new DadosferaLogger(); - + process.env.INTERNAL_SWAGGER = 'true'; const app = await NestFactory.create(AppModule, { logger, cors: { @@ -24,9 +24,20 @@ async function bootstrap() { optionsSuccessStatus: 204, }, }); + process.env.INTERNAL_SWAGGER = 'true'; + const app2 = await NestFactory.create(AppModule, { + logger, + cors: { + origin: '*', + methods: 'GET,HEAD,PUT,PATCH,POST,DELETE', + preflightContinue: false, + optionsSuccessStatus: 204, + }, + }); app.use(helmet()); configureSwagger(app); + // configureSwagger(app2); await app.listen(3333); } @@ -56,9 +67,14 @@ function configureSwagger(app: INestApplication) { const document = SwaggerModule.createDocument(app, config); + let swaggerJsonFile = 'docsfera.external.json'; + if (process.env.INTERNAL_SWAGGER === 'true') { + swaggerJsonFile = 'docsfera.json'; + } if (process.env.ENV === 'local') SwaggerModule.setup('api', app, document); + writeFileSync( - 'docsfera.json', + swaggerJsonFile, JSON.stringify( { service: '${DOCS_API_TOKEN}', diff --git a/src/modules/auth/auth.controller.ts b/src/modules/auth/auth.controller.ts index 4417a3e..1097d51 100644 --- a/src/modules/auth/auth.controller.ts +++ b/src/modules/auth/auth.controller.ts @@ -51,6 +51,7 @@ import ErrorCodes, { OauthErrors } from 'src/utils/errorCodes'; import jwt from 'jsonwebtoken'; import { LanguageEnum } from 'src/utils/languages.enum'; import { Language } from 'src/decorators/language.decorator'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; @ApiTags('Auth') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @@ -90,21 +91,6 @@ export class AuthController { return this.authClient.signIn({ username, password, totp }, metadata); } - @Post('/sso/snowflake') - @RequireAllPermissions(PERMISSIONS_GROUPS.SNOWFLAKE.permissions.OPEN) - @HttpCode(HttpStatus.OK) - async snowflakeSignIn( - @User() user: RequestUser, - @Body('RelayState') relayState: string, - ) { - this.logger.info('/auth - snowflakeSignIn'); - - return this.authClient.snowflakeSignIn({ - userId: user.user_id, - relayState, - }); - } - @Post('refresh-access-token') @HttpCode(HttpStatus.OK) @ApiOkResponse({ type: AuthRefreshAccessTokenRes }) @@ -123,6 +109,23 @@ export class AuthController { return this.authClient.refreshAccessToken({ refreshToken }, metadata); } + @ApiInternalOnlyEndpoint() + @Post('/sso/snowflake') + @RequireAllPermissions(PERMISSIONS_GROUPS.SNOWFLAKE.permissions.OPEN) + @HttpCode(HttpStatus.OK) + async snowflakeSignIn( + @User() user: RequestUser, + @Body('RelayState') relayState: string, + ) { + this.logger.info('/auth - snowflakeSignIn'); + + return this.authClient.snowflakeSignIn({ + userId: user.user_id, + relayState, + }); + } + + @ApiInternalOnlyEndpoint() @Post('change-password') @HttpCode(HttpStatus.OK) async changePassword( @@ -141,6 +144,7 @@ export class AuthController { }); } + @ApiInternalOnlyEndpoint() @Post('reset-password') @HttpCode(HttpStatus.OK) async resetPassword( @@ -157,6 +161,7 @@ export class AuthController { return this.authClient.resetPassword({ username }, metadata); } + @ApiInternalOnlyEndpoint() @Post('verify-reset-password-code') @HttpCode(HttpStatus.OK) async verifyResetPasswordCode( @@ -169,6 +174,7 @@ export class AuthController { return this.authClient.verifyResetPasswordCode({ username, code }); } + @ApiInternalOnlyEndpoint() @Post('confirm-reset-password') @HttpCode(HttpStatus.OK) async confirmResetPassword(@Body() body: AuthConfirmResetPasswordRequest) { @@ -183,6 +189,7 @@ export class AuthController { }); } + @ApiInternalOnlyEndpoint() @Post('enable-totp') @HttpCode(HttpStatus.OK) async enableTotpMFA( @@ -197,6 +204,7 @@ export class AuthController { return this.authClient.enableTotpMFA({ accessToken, password }); } + @ApiInternalOnlyEndpoint() @Post('disable-totp') @HttpCode(HttpStatus.OK) async disableTotpMFA( @@ -211,6 +219,7 @@ export class AuthController { return this.authClient.disableTotpMFA({ accessToken, password }); } + @ApiInternalOnlyEndpoint() @Post('dismiss-totp') @HttpCode(HttpStatus.OK) async dismissTotpMFA(@Headers() headers) { @@ -221,6 +230,7 @@ export class AuthController { return this.authClient.dismissTotpMFA({ accessToken }); } + @ApiInternalOnlyEndpoint() @Post('verify-totp') @HttpCode(HttpStatus.OK) async verifyTotp(@Body() body: AuthVerifyTotpMfaRequest, @Headers() headers) { @@ -232,6 +242,7 @@ export class AuthController { return this.authClient.verifyTotp({ accessToken, totp }); } + @ApiInternalOnlyEndpoint() @Authenticated() @ApiSecurity('access-token') @Get('verify-access-token') @@ -239,11 +250,13 @@ export class AuthController { return { access_token_status: 'valid' }; } + @ApiInternalOnlyEndpoint() @Get('session/:session') getSession(@Param('session') session: string) { return this.authClient.getSession(session); } + @ApiInternalOnlyEndpoint() @Get('oauth/google') @UseGuards(AuthGuard('google-login')) googleOauth() { @@ -251,6 +264,7 @@ export class AuthController { return true; } + @ApiInternalOnlyEndpoint() @Get('oauth/google/callback') @UseGuards(AuthGuard('google-login')) @Redirect() diff --git a/src/modules/catalog/catalog.controller.ts b/src/modules/catalog/catalog.controller.ts index 2614b3c..6583726 100644 --- a/src/modules/catalog/catalog.controller.ts +++ b/src/modules/catalog/catalog.controller.ts @@ -39,6 +39,7 @@ import { import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter'; import { Language } from 'src/decorators/language.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; @ApiTags('Catalog') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @@ -94,6 +95,7 @@ export class CatalogController { return res; } + @ApiInternalOnlyEndpoint() @Get('data-asset') async findByPipelineAndObject(@User() user: RequestUser, @Query() query) { const { username, user_id, customer_id, customer_name, permissions } = user; @@ -147,6 +149,7 @@ export class CatalogController { ); } + @ApiInternalOnlyEndpoint() @Get('tags') @RequireSomePermission( PERMISSIONS_GROUPS.CATALOG.permissions.GET, @@ -225,6 +228,7 @@ export class CatalogController { return { data_asset }; } + @ApiInternalOnlyEndpoint() @Get('data-asset/rls/:id') @RequireSomePermission( PERMISSIONS_GROUPS.CATALOG.permissions.GET, @@ -433,6 +437,7 @@ export class CatalogController { return res; } + @ApiInternalOnlyEndpoint() @Put('data-asset/:id/manage-permissions') async manageDataAssetPermissions( @Param('id') id: string, @@ -454,6 +459,7 @@ export class CatalogController { return { data_asset: JSON.parse(response.data_asset) }; } + @ApiInternalOnlyEndpoint() @Put('data-asset/:id/revoke-permissions') async revokeDataAssetPermissions( @Param('id') id: string, diff --git a/src/modules/connection/connection.controller.ts b/src/modules/connection/connection.controller.ts index a2245c1..255daba 100644 --- a/src/modules/connection/connection.controller.ts +++ b/src/modules/connection/connection.controller.ts @@ -31,6 +31,7 @@ import { PackTheMetadata } from 'src/utils/ PackTheMetadata'; import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter'; import { Language } from 'src/decorators/language.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; const connectionPermissions = PERMISSIONS_GROUPS.CONNECTION.permissions; @UseFilters(new GrpcToHttpExceptionFilter()) @@ -47,6 +48,7 @@ export class ConnectionController { this.logger = dadosferaLogger.logger; } + @ApiInternalOnlyEndpoint() @Get('connections-migration') @ApiExcludeEndpoint() @RequireAllPermissions( diff --git a/src/modules/connector/connector.controller.ts b/src/modules/connector/connector.controller.ts index a786912..10c57e4 100644 --- a/src/modules/connector/connector.controller.ts +++ b/src/modules/connector/connector.controller.ts @@ -30,7 +30,9 @@ import { import { PERMISSIONS_GROUPS } from 'src/authentication/permissions.enum'; import { Language } from 'src/decorators/language.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; +@ApiInternalOnlyController() @ApiTags('connectors') @Authenticated() @Controller('connectors') diff --git a/src/modules/inputs/inputs.controller.ts b/src/modules/inputs/inputs.controller.ts index d7670bf..0145bc3 100644 --- a/src/modules/inputs/inputs.controller.ts +++ b/src/modules/inputs/inputs.controller.ts @@ -24,6 +24,7 @@ import { UpdateInputRequest } from './dtos/old_interfaces'; import { RequestUser, User } from 'src/decorators/user.decorator'; import { Info } from '@dadosfera/protospack-v2/dist/lib/Input/interfaces/entities'; import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; @ApiTags('Inputs') @Controller('inputs') @@ -66,6 +67,7 @@ export class InputsController { this.logger = dadosferaLogger.logger; } + @ApiInternalOnlyEndpoint() @Get('available-entities/:plugin') @ApiOkResponse({ type: GetAvailableEntitiesRes }) async getAvailableEntities( @@ -102,6 +104,7 @@ export class InputsController { return response; } + @ApiInternalOnlyEndpoint() @Get() async findAll(@User() user: RequestUser) { const { user_id, customer_id, customer_name: customer } = user; @@ -132,6 +135,7 @@ export class InputsController { return response; } + @ApiInternalOnlyEndpoint() @Patch(':id') async update(@Body() updateInputDto: UpdateInputRequest, @Param() params) { const { id } = params; @@ -147,6 +151,7 @@ export class InputsController { return response; } + @ApiInternalOnlyEndpoint() @Delete(':id') async delete(@Body() data, @Param() params) { const { id } = params; diff --git a/src/modules/mixpanel/mixpanel.controller.ts b/src/modules/mixpanel/mixpanel.controller.ts index cb1b641..76f7809 100644 --- a/src/modules/mixpanel/mixpanel.controller.ts +++ b/src/modules/mixpanel/mixpanel.controller.ts @@ -1,8 +1,10 @@ import { Body, Controller, Inject, Param, Post } from '@nestjs/common'; import { init } from 'mixpanel'; import { Authenticated } from 'src/decorators/authentication.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; import { RequestUser, User } from 'src/decorators/user.decorator'; +@ApiInternalOnlyController() @Authenticated() @Controller('trackEvent') export class MixpanelController { diff --git a/src/modules/network-config/network-config-client.config.ts b/src/modules/network-config/network-config-client.config.ts index 09bed03..a5227f8 100644 --- a/src/modules/network-config/network-config-client.config.ts +++ b/src/modules/network-config/network-config-client.config.ts @@ -6,6 +6,8 @@ import { } from '@nestjs/microservices'; import { NetworkConfig } from '@dadosfera/protospack-v2'; +const isLocalConnection = !!process.env.INFACTORY_URL?.includes('0.0.0.0'); + export class NetworkConfigGrpcClient { public name = 'NetworkConfigGrpcClient'; @@ -17,8 +19,7 @@ export class NetworkConfigGrpcClient { NetworkConfig.ProtoPackages.ReadPackage, NetworkConfig.ProtoPackages.WritePackage, ], - credentials: - process.env.ENV === 'local' ? undefined : credentials.createSsl(), + credentials: isLocalConnection ? undefined : credentials.createSsl(), protoPath: [ NetworkConfig.ProtoPaths.ReadFilePath, NetworkConfig.ProtoPaths.WriteFilePath, diff --git a/src/modules/network-config/network-config.controller.ts b/src/modules/network-config/network-config.controller.ts index 26c0df7..1c7552c 100644 --- a/src/modules/network-config/network-config.controller.ts +++ b/src/modules/network-config/network-config.controller.ts @@ -39,6 +39,7 @@ export class NetworkConfigController { ) { this.logger = dadosferaLogger.logger; } + @Get() @ApiOkResponse({ type: FindAllNetworkConfigsRes }) async findAllNetworkConfigs( diff --git a/src/modules/oauth/oauth.controller.ts b/src/modules/oauth/oauth.controller.ts index 2feb441..1e87866 100644 --- a/src/modules/oauth/oauth.controller.ts +++ b/src/modules/oauth/oauth.controller.ts @@ -5,6 +5,7 @@ import { ConnectionClientService } from '../connection/client.service'; import jwt from 'jsonwebtoken'; import DadosferaLogger from '@dadosfera/dadosfera-logs/dist'; import { PackTheMetadata } from 'src/utils/ PackTheMetadata'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; @ApiTags('oauth') @Controller('oauth') export class OauthController { @@ -31,6 +32,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('hubspot/callback') @UseGuards(AuthGuard('hubspot')) @Redirect() @@ -44,6 +46,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('googleads/callback') @UseGuards(AuthGuard('google')) @Redirect() @@ -57,6 +60,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('google-sheets/callback') @UseGuards(AuthGuard('google')) @Redirect() @@ -70,6 +74,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('facebook/callback') @UseGuards(AuthGuard('facebook')) @Redirect() @@ -83,6 +88,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('mailchimp/callback') @UseGuards(AuthGuard('mailchimp')) @Redirect() @@ -96,6 +102,7 @@ export class OauthController { return true; } + @ApiInternalOnlyEndpoint() @Get('salesforce/callback') @UseGuards(AuthGuard('salesforce')) @Redirect() diff --git a/src/modules/permissions/permissions.controller.ts b/src/modules/permissions/permissions.controller.ts index 45b46d0..13494bd 100644 --- a/src/modules/permissions/permissions.controller.ts +++ b/src/modules/permissions/permissions.controller.ts @@ -8,7 +8,9 @@ import { LanguageEnum } from 'src/utils/languages.enum'; import { GetPublicPermissionsRes } from './dto/entities'; import { PermissionsService } from './permissions.service'; import { Language } from 'src/decorators/language.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; +@ApiInternalOnlyController() @ApiTags('Permissions') @Authenticated() @Controller('permissions') diff --git a/src/modules/permissions/permissions.service.ts b/src/modules/permissions/permissions.service.ts index fefb723..9ea6ac8 100644 --- a/src/modules/permissions/permissions.service.ts +++ b/src/modules/permissions/permissions.service.ts @@ -60,7 +60,7 @@ export class PermissionsService }).catch((err: ErrorBuilder) => { if ( err.code === 'No connection established' && - (process.env.LOCAL_ENV === 'true' || process.env.ENV === 'local') + process.env.ENV === 'local' ) { return this.logger.info( "couldn't connect to DUC. suppressing in local env", diff --git a/src/modules/pipelines/pipelines.controller.ts b/src/modules/pipelines/pipelines.controller.ts index ea094b8..0d967a2 100644 --- a/src/modules/pipelines/pipelines.controller.ts +++ b/src/modules/pipelines/pipelines.controller.ts @@ -7,7 +7,9 @@ import { import { PERMISSIONS_GROUPS } from '../../authentication/permissions.enum'; import { PipelinesService } from './pipelines.service'; import { DadosferaLogger } from '@dadosfera/dadosfera-logs'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; +@ApiInternalOnlyController() @ApiTags('Pipelines') @Controller('pipelines') @Authenticated() diff --git a/src/modules/pipelinesV2/pipelines.controller.ts b/src/modules/pipelinesV2/pipelines.controller.ts index 66d5e1e..c457f33 100644 --- a/src/modules/pipelinesV2/pipelines.controller.ts +++ b/src/modules/pipelinesV2/pipelines.controller.ts @@ -44,6 +44,7 @@ import { import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter'; import { LanguageEnum } from 'src/utils/languages.enum'; import { Language } from 'src/decorators/language.decorator'; +import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator'; @ApiTags('PipelinesV2') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @@ -279,6 +280,7 @@ export class PipelinesController { return response; } + @ApiInternalOnlyEndpoint() @Put('/:id') @ApiOperation({ deprecated: true, @@ -290,9 +292,9 @@ export class PipelinesController { @Param('id') id, @User() user: RequestUser, ) { - this.logger.info('PipelinesController - patch', { user }); + this.logger.info('PipelinesController - put', { user }); const response = await this.update(language, updatePipelineDto, id, user); - this.logger.info('PipelinesController - patch: OK', { user }); + this.logger.info('PipelinesController - put: OK', { user }); return response; } @@ -311,6 +313,7 @@ export class PipelinesController { this.logger.info('PipelinesController - delete: OK'); } + @ApiInternalOnlyEndpoint() @Post('/init-upload') @RequireAllPermissions(PERMISSIONS_GROUPS.PIPELINE.permissions.CREATE) async initUploadFile( @@ -342,6 +345,7 @@ export class PipelinesController { return { urls: JSON.parse(urls), upload_id }; } + @ApiInternalOnlyEndpoint() @Post('/complete-upload') @RequireAllPermissions(PERMISSIONS_GROUPS.PIPELINE.permissions.CREATE) async completeUploadFile( @@ -359,6 +363,7 @@ export class PipelinesController { ); } + @ApiInternalOnlyEndpoint() @Post('/file') @RequireAllPermissions(PERMISSIONS_GROUPS.PIPELINE.permissions.CREATE) async uploadedFile( @@ -401,6 +406,7 @@ export class PipelinesController { return pipeline; } + @ApiInternalOnlyEndpoint() @Post('start/:id') async activate(@Param() params, @Body() body) { const { id } = params; diff --git a/src/modules/productboard/productboard.controller.ts b/src/modules/productboard/productboard.controller.ts index 481b6f1..749b03d 100644 --- a/src/modules/productboard/productboard.controller.ts +++ b/src/modules/productboard/productboard.controller.ts @@ -2,10 +2,12 @@ import { Body, Controller, HttpException, Post } from '@nestjs/common'; import { ApiTags } from '@nestjs/swagger'; import axios from 'axios'; import { Authenticated } from 'src/decorators/authentication.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; import { User, RequestUser } from 'src/decorators/user.decorator'; import { getSecretFromSecretsManager } from 'src/utils/SecretManager'; import { INote } from './dtos'; +@ApiInternalOnlyController() @ApiTags('Productboard') @Controller('productboard') @Authenticated() diff --git a/src/modules/roles/roles.controller.ts b/src/modules/roles/roles.controller.ts index f3fa0bb..a595bcf 100644 --- a/src/modules/roles/roles.controller.ts +++ b/src/modules/roles/roles.controller.ts @@ -45,7 +45,9 @@ import { } from 'src/decorators/authentication.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; import { Language } from 'src/decorators/language.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; +@ApiInternalOnlyController() @ApiTags('Roles') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @Authenticated() diff --git a/src/modules/termsOfUse/termsOfUse.controller.ts b/src/modules/termsOfUse/termsOfUse.controller.ts index 7d23139..d2d3fb1 100644 --- a/src/modules/termsOfUse/termsOfUse.controller.ts +++ b/src/modules/termsOfUse/termsOfUse.controller.ts @@ -20,7 +20,9 @@ import { RequestUser, User } from '../../decorators/user.decorator'; import { Metadata } from '@grpc/grpc-js'; import { Language } from 'src/decorators/language.decorator'; import { LanguageEnum } from 'src/utils/languages.enum'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; +@ApiInternalOnlyController() @ApiTags('TermsOfUse') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }]) @UseFilters(new GrpcToHttpExceptionFilter()) diff --git a/src/modules/transformations/transformations.controller.ts b/src/modules/transformations/transformations.controller.ts index df66c44..4cedddb 100644 --- a/src/modules/transformations/transformations.controller.ts +++ b/src/modules/transformations/transformations.controller.ts @@ -19,7 +19,10 @@ import { PERMISSIONS_GROUPS } from '../../authentication/permissions.enum'; import { TransformationsService } from './transformations.service'; import { DadosferaLogger } from '@dadosfera/dadosfera-logs'; import { RequestUser, User } from 'src/decorators/user.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; const pipelinePermissions = PERMISSIONS_GROUPS.PIPELINE.permissions; + +@ApiInternalOnlyController() @ApiTags('Transformations') @Controller('transformations') @Authenticated() diff --git a/src/modules/users/users.controller.ts b/src/modules/users/users.controller.ts index 308d4fd..9e00f7c 100644 --- a/src/modules/users/users.controller.ts +++ b/src/modules/users/users.controller.ts @@ -26,6 +26,7 @@ import { RequireAllPermissions, } from 'src/decorators/authentication.decorator'; import { Language } from 'src/decorators/language.decorator'; +import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator'; import { RequestUser, User } from 'src/decorators/user.decorator'; import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter'; import { PackTheMetadata } from 'src/utils/ PackTheMetadata'; @@ -52,6 +53,7 @@ import { } from './dtos/entities'; import { UsersService } from './users.service'; +@ApiInternalOnlyController() @ApiTags('Users') @Controller('users') @ApiHeaders([{ name: 'dadosfera-lang', enum: LanguageEnum, required: false }])