{ "service": "${DOCS_API_TOKEN}", "pageId": "${DOCS_PAGE_ID}", "blockId": "${DOCS_BLOCK_ID}", "schema": { "openapi": "3.0.0", "paths": { "/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": [ { "bearer": [] } ] }, "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": [ { "bearer": [] } ] } }, "/connectors/uploads": { "post": { "operationId": "ConnectorController_uploadFile", "parameters": [], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "tags": [ "connectors" ], "security": [ { "bearer": [] } ] } }, "/connectors/multiple-connectors-upload": { "post": { "operationId": "ConnectorController_uploadConnectorsFile", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "connectors" ], "security": [ { "bearer": [] } ] } }, "/connectors/tags": { "get": { "operationId": "ConnectorController_getConnectorsTags", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "connectors" ], "security": [ { "bearer": [] } ] } }, "/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": [ { "bearer": [] } ] }, "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": [ { "bearer": [] } ] }, "delete": { "operationId": "ConnectorController_deleteConnector", "parameters": [ { "name": "plugin", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectorDto" } } } }, "responses": { "200": { "description": "" } }, "tags": [ "connectors" ], "security": [ { "bearer": [] } ] } }, "/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": [ { "bearer": [] } ] } }, "/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": [ { "bearer": [] } ] } }, "/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": [ { "bearer": [] } ] } }, "/auth/sso/snowflake": { "post": { "operationId": "AuthController_snowflakeSignIn", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/sign-in": { "post": { "operationId": "AuthController_signIn", "parameters": [ { "name": "Dadosfera-Lang", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/refresh-access-token": { "post": { "operationId": "AuthController_refreshAccessToken", "parameters": [ { "name": "Dadosfera-Lang", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/change-password": { "post": { "operationId": "AuthController_changePassword", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/reset-password": { "post": { "operationId": "AuthController_resetPassword", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/verify-reset-password-code": { "post": { "operationId": "AuthController_verifyResetPasswordCode", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/confirm-reset-password": { "post": { "operationId": "AuthController_confirmResetPassword", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/enable-totp": { "post": { "operationId": "AuthController_enableTotpMFA", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/disable-totp": { "post": { "operationId": "AuthController_disableTotpMFA", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/dismiss-totp": { "post": { "operationId": "AuthController_dismissTotpMFA", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/auth/verify-totp": { "post": { "operationId": "AuthController_verifyTotp", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Auth" ] } }, "/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" ] } }, "/terms-of-use/token": { "get": { "operationId": "TermsOfUseController_getToken", "parameters": [ { "name": "Dadosfera-Lang", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "TermsOfUse" ] } }, "/terms-of-use/accept": { "post": { "operationId": "TermsOfUseController_accept", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "TermsOfUse" ] } }, "/connections/connections-migration": { "get": { "operationId": "ConnectionController_synchronizeConnections", "parameters": [ { "name": "apply", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "connections" ], "security": [ { "bearer": [] } ] } }, "/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": [ { "bearer": [] } ] }, "get": { "operationId": "ConnectionController_getAllConnections", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsRes" } } } } }, "tags": [ "connections" ], "security": [ { "bearer": [] } ] } }, "/connections/{id}": { "put": { "operationId": "ConnectionController_updateConnection", "parameters": [ { "name": "Dadosfera-Lang", "required": true, "in": "header", "schema": { "type": "string" } }, { "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": [ { "bearer": [] } ] }, "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": [ { "bearer": [] } ] }, "get": { "operationId": "ConnectionController_getConnectionDetails", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionDetailsRes" } } } } }, "tags": [ "connections" ], "security": [ { "bearer": [] } ] } }, "/users": { "get": { "operationId": "UsersController_getAllUsersByCustomerId", "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/GetAllUsersByCustomerIdRes" } } } } }, "tags": [ "Users" ] }, "post": { "operationId": "UsersController_createUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/hierarchies": { "get": { "operationId": "UsersController_getAllHierarchies", "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/GetAllHierarchiesRes" } } } } }, "tags": [ "Users" ] } }, "/users/departments": { "get": { "operationId": "UsersController_getAllDepartments", "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/GetAllDepartmentsRes" } } } } }, "tags": [ "Users" ] } }, "/users/jobTitles": { "get": { "operationId": "UsersController_getAllJobTitles", "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/GetAllDepartmentsRes" } } } } }, "tags": [ "Users" ] } }, "/users/{id}": { "get": { "operationId": "UsersController_findOneById", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "delete": { "operationId": "UsersController_deleteUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "patch": { "operationId": "UsersController_updateUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/batch": { "post": { "operationId": "UsersController_batchCreateUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/{id}/resend-invite": { "post": { "operationId": "UsersController_resendInvite", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/role": { "delete": { "operationId": "UsersController_unassignRoleToUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "put": { "operationId": "UsersController_assignRoleToUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/roles": { "patch": { "operationId": "UsersController_setUserRoles", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/users/synchronize/{id}": { "post": { "operationId": "UsersController_synchronizeUser", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/roles": { "get": { "operationId": "RolesController_searchRoles", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRolesByCustomerRes" } } } } }, "tags": [ "Roles" ] }, "post": { "operationId": "RolesController_createRole", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/roles/permissions": { "put": { "operationId": "RolesController_grantPermissionsToRole", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "delete": { "operationId": "RolesController_revokePermissionsFromRole", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "patch": { "operationId": "RolesController_setRolePermissions", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/roles/users": { "patch": { "operationId": "RolesController_setRoleUsers", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/roles/{id}": { "get": { "operationId": "RolesController_getRoleById", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "delete": { "operationId": "RolesController_deleteRole", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] }, "patch": { "operationId": "RolesController_updateRole", "parameters": [ { "name": "dadosfera-lang", "in": "header", "description": "Defaults to pt-br", "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" ] } }, "/network-config": { "get": { "operationId": "NetworkConfigController_findAllNetworkConfigs", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindAllNetworkConfigsRes" } } } } }, "tags": [ "Network Config" ] }, "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" ] } }, "/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" ] } }, "/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" ] } }, "/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" ] } }, "/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" ] } }, "/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" ] } }, "/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" ] } }, "/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" ] } }, "/pipelines/start/{id}": { "post": { "operationId": "PipelinesController_activate", "parameters": [], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelines/{id}/status": { "get": { "operationId": "PipelinesController_getPipelineStatus", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Pipelines" ] } }, "/pipelinesV2": { "post": { "operationId": "PipelinesController_create", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICreatePipelineV2Req" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPipelineV2" } } } } }, "tags": [ "PipelinesV2" ] }, "get": { "operationId": "PipelinesController_findAll", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "PipelinesV2" ] } }, "/pipelinesV2/{id}/config": { "get": { "operationId": "PipelinesController_getPipelineproperties", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "PipelinesV2" ] } }, "/pipelinesV2/{id}": { "get": { "operationId": "PipelinesController_findOne", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "PipelinesV2" ] }, "put": { "operationId": "PipelinesController_update", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "PipelinesV2" ] }, "delete": { "operationId": "PipelinesController_delete", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "PipelinesV2" ] } }, "/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" ] } }, "/inputs/test-connection": { "post": { "operationId": "InputsController_testConnection", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionReq" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionRes" } } } }, "201": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Inputs" ] } }, "/inputs/test-connection/get-columns": { "post": { "operationId": "InputsController_getColumns", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionGetColumnsReq" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionGetColumnsRes" } } } }, "201": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Inputs" ] } }, "/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" ] }, "get": { "operationId": "InputsController_findAll", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "Inputs" ] } }, "/inputs/{id}": { "get": { "operationId": "InputsController_findOne", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Inputs" ] }, "patch": { "operationId": "InputsController_update", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Inputs" ] }, "delete": { "operationId": "InputsController_delete", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Inputs" ] } }, "/transformations": { "post": { "operationId": "TransformationsController_create", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "Transformations" ] }, "get": { "operationId": "TransformationsController_findAll", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "Transformations" ] } }, "/transformations/{id}": { "get": { "operationId": "TransformationsController_findOne", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Transformations" ] }, "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" ] }, "delete": { "operationId": "TransformationsController_delete", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Transformations" ] } }, "/health": { "get": { "operationId": "HealthController_check", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "Health" ] } }, "/catalog": { "get": { "operationId": "CatalogController_catalogAll", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICatalogAllResponse" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/tags": { "get": { "operationId": "CatalogController_findAllTags", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}": { "get": { "operationId": "CatalogController_getDataAsset", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] }, "put": { "operationId": "CatalogController_updateDataAsset", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IUpdateDataRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IOneDataAsset" } } } } }, "tags": [ "Catalog" ] }, "delete": { "operationId": "CatalogController_deleteDataAsset", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/rls/{id}": { "get": { "operationId": "CatalogController_getDataAssetRls", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/columns-metadata": { "get": { "operationId": "CatalogController_getDataAssetColumnsMetadata", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IColumnsMetadataResponse" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/preview": { "get": { "operationId": "CatalogController_getDataAssetPreview", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPreviewResponse" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/docs": { "get": { "operationId": "CatalogController_getDataAssetDocs", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDocsResponse" } } } } }, "tags": [ "Catalog" ] }, "post": { "operationId": "CatalogController_manageDataAssetDocs", "parameters": [], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/manage-permissions": { "put": { "operationId": "CatalogController_manageDataAssetPermissions", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/revoke-permissions": { "put": { "operationId": "CatalogController_revokeDataAssetPermissions", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Catalog" ] } }, "/catalog/data-asset/{id}/comment": { "post": { "operationId": "CatalogController_commentOnDataAsset", "parameters": [ { "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" ] }, "delete": { "operationId": "CatalogController_deleteComment", "parameters": [ { "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" ] } }, "/oauth/hubspot": { "get": { "operationId": "OauthController_oauthHubspot", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/hubspot/callback": { "get": { "operationId": "OauthController_oauthHubspotCallback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "oauth" ] } }, "/oauth/googleads": { "get": { "operationId": "OauthController_oauthGoogleAds", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/googleads/callback": { "get": { "operationId": "OauthController_oauthGoogleAdsCallback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "oauth" ] } }, "/oauth/google-sheets": { "get": { "operationId": "OauthController_oauthGoogleSheets", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/google-sheets/callback": { "get": { "operationId": "OauthController_oauthGoogleSheetsCallback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "oauth" ] } }, "/oauth/facebook": { "get": { "operationId": "OauthController_oauthFacebook", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/facebook/callback": { "get": { "operationId": "OauthController_oauthFacebookCallback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "oauth" ] } }, "/oauth/mailchimp": { "get": { "operationId": "OauthController_oauthMailchimp", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/mailchimp/callback": { "get": { "operationId": "OauthController_oauthMailchimpCallback", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "oauth" ] } }, "/oauth/salesforce": { "get": { "operationId": "OauthController_oauthSalesforce", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "tags": [ "oauth" ] } }, "/oauth/salesforce/callback": { "get": { "operationId": "OauthController_oauthSalesforceCallback", "parameters": [], "responses": { "200": { "description": "" } }, "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" ] } } }, "info": { "title": "Maestro", "description": "Documentation for Maestro gateway", "version": "feat/rest-api", "contact": {} }, "tags": [], "servers": [], "components": { "securitySchemes": { "Authorization": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "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" ] }, "DeleteConnectorDto": { "type": "object", "properties": { "version": { "type": "string" } }, "required": [ "version" ] }, "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": { "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" ] }, "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" } }, "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" } }, "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" } }, "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": { "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" ] }, "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" ] }, "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" ] }, "GetAvailableEntitiesRes": { "type": "object", "properties": { "entities": { "type": "array", "items": { "type": "string" } } }, "required": [ "entities" ] }, "CredentialsJdbc": { "type": "object", "properties": { "jdbc_user": { "type": "string" }, "jdbc_password": { "type": "string" }, "database": { "type": "string" }, "endpoint": { "type": "string" }, "port": { "type": "string" }, "engine": { "type": "string" }, "schema": { "type": "string" } } }, "TestConnectionReq": { "type": "object", "properties": { "plugin": { "type": "string" }, "credentials": { "$ref": "#/components/schemas/CredentialsJdbc" }, "info": { "type": "object" } }, "required": [ "plugin", "credentials" ] }, "TestConnectionRes": { "type": "object", "properties": { "connection_state": { "type": "boolean" }, "total_entities": { "type": "number" }, "database_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "connection_state", "total_entities", "database_tables" ] }, "TestConnectionGetColumnsReq": { "type": "object", "properties": { "plugin": { "type": "string" }, "tables": { "type": "array", "items": { "type": "string" } }, "credentials": { "$ref": "#/components/schemas/CredentialsJdbc" }, "id": { "type": "string" }, "info": { "type": "object" } }, "required": [ "plugin", "tables" ] }, "TableColumns": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "references": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "columns", "references" ] }, "TestConnectionGetColumnsRes": { "type": "object", "properties": { "tables": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumns" } } }, "required": [ "tables" ] }, "FileFormatParams": { "type": "object", "properties": { "sep": { "type": "string" }, "header": { "type": "boolean" }, "encoding": { "type": "string" } }, "required": [ "sep", "header", "encoding" ] }, "GoogleAnalyticsClientSecrets": { "type": "object", "properties": { "type": { "type": "string" }, "project_id": { "type": "string" }, "private_key_id": { "type": "string" }, "private_key": { "type": "string" }, "client_email": { "type": "string" }, "client_id": { "type": "string" }, "auth_uri": { "type": "string" }, "token_uri": { "type": "string" }, "auth_provider_x509_cert_url": { "type": "string" }, "client_x509_cert_url": { "type": "string" } }, "required": [ "type", "project_id", "private_key_id", "private_key", "client_email", "client_id", "auth_uri", "token_uri", "auth_provider_x509_cert_url", "client_x509_cert_url" ] }, "Credentials": { "type": "object", "properties": { "jdbc_user": { "type": "string" }, "jdbc_password": { "type": "string" }, "database": { "type": "string" }, "endpoint": { "type": "string" }, "port": { "type": "string" }, "engine": { "type": "string" }, "schema": { "type": "string" }, "connection_type": { "type": "string" }, "client_aws_access_key_id": { "type": "string" }, "client_aws_secret_access_key": { "type": "string" }, "client_bucket": { "type": "string" }, "file_to_extract": { "type": "string" }, "file_format_params": { "$ref": "#/components/schemas/FileFormatParams" }, "view_id": { "type": "string" }, "client_secrets": { "$ref": "#/components/schemas/GoogleAnalyticsClientSecrets" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "oauth_code": { "type": "string" } }, "required": [ "connection_type" ] }, "OauthObject": { "type": "object", "properties": { "get_tokens_url": { "type": "string" }, "get_tokens_url_params": { "type": "string" }, "get_tokens_set_response": { "type": "object" }, "content_type": { "type": "string" } } }, "InputOptions": { "type": "object", "properties": { "oauth": { "$ref": "#/components/schemas/OauthObject" }, "skip_select_columns": { "type": "boolean" }, "skip_select_entities": { "type": "boolean" }, "skip_transformation": { "type": "boolean" } } }, "AuthParameters": { "type": "object", "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" } }, "required": [ "aws_access_key_id", "aws_secret_access_key" ] }, "CreateInputReq": { "type": "object", "properties": { "tables": { "type": "array", "items": { "$ref": "#/components/schemas/TableColumns" } }, "name": { "type": "string" }, "description": { "type": "string" }, "plugin": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string", "deprecated": true }, "credentials": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/Credentials" } ] }, "options": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/InputOptions" } ] }, "info": { "type": "object", "deprecated": true }, "cron": { "type": "string", "deprecated": true }, "source_bucket": { "type": "string", "deprecated": true }, "source_prefix": { "type": "string", "deprecated": true }, "auth_parameters": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/AuthParameters" } ] }, "file_format_params": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/FileFormatParams" } ] } }, "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" }, "category": { "type": "string", "deprecated": true }, "credentials": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/Credentials" } ] }, "options": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/InputOptions" } ] }, "info": { "type": "object", "deprecated": true }, "cron": { "type": "string", "deprecated": true }, "source_bucket": { "type": "string", "deprecated": true }, "source_prefix": { "type": "string", "deprecated": true }, "auth_parameters": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/AuthParameters" } ] }, "file_format_params": { "deprecated": true, "allOf": [ { "$ref": "#/components/schemas/FileFormatParams" } ] } }, "required": [ "id", "tables", "name", "description", "plugin", "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" ] }, "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" } } }, "required": [ "id", "pipeline_id", "user_id", "description", "data_asset_type", "tags", "owner", "roles", "users", "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" } } }, "required": [ "name", "description", "tags" ] }, "IOneDataAsset": { "type": "object", "properties": { "data_asset": { "$ref": "#/components/schemas/IDataAsset" } }, "required": [ "data_asset" ] }, "IMakeAComment": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "IDeleteComment": { "type": "object", "properties": { "comment": { "$ref": "#/components/schemas/IComment" } }, "required": [ "comment" ] }, "INote": { "type": "object", "properties": { "title": { "type": "string" }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "content", "tags" ] } } } } }