diff --git a/docsfera.json b/docsfera.json index 1fdca24..a4f3757 100644 --- a/docsfera.json +++ b/docsfera.json @@ -93,6 +93,455 @@ ] } }, + "/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/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" + ] + } + }, "/connections": { "post": { "operationId": "ConnectionController_createConnection", @@ -264,6 +713,1630 @@ ] } }, + "/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": [] + } + ] + } + }, + "/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": [] + } + ] + } + }, + "/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": [] + } + ] + } + }, "/network-config": { "get": { "operationId": "NetworkConfigController_findAllNetworkConfigs", @@ -407,6 +2480,41 @@ ] } }, + "/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", @@ -444,6 +2552,23 @@ "access-token": [] } ] + }, + "get": { + "operationId": "InputsController_findAll", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Inputs" + ], + "security": [ + { + "access-token": [] + } + ] } }, "/inputs/{id}": { @@ -470,6 +2595,54 @@ "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": [] + } + ] } }, "/pipelinesV2": { @@ -769,6 +2942,46 @@ } ] }, + "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": [ @@ -800,6 +3013,392 @@ ] } }, + "/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": [] + } + ] + } + }, + "/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" + } + } + } + } + }, + "tags": [ + "Pipelines" + ], + "security": [ + { + "access-token": [] + }, + { + "access-token": [] + } + ] + } + }, + "/pipelines/{id}/status": { + "get": { + "operationId": "PipelinesController_getPipelineStatus", + "summary": "", + "deprecated": true, + "description": "This method is deprecated. Please use route /pipelinesV2/:id/status instead", + "parameters": [], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "tags": [ + "Pipelines" + ], + "security": [ + { + "access-token": [] + }, + { + "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": [] + } + ] + } + }, "/catalog": { "get": { "operationId": "CatalogController_searchCatalog", @@ -908,6 +3507,80 @@ ] } }, + "/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", @@ -1049,6 +3722,41 @@ ] } }, + "/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", @@ -1223,6 +3931,86 @@ ] } }, + "/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", @@ -1341,6 +4129,74 @@ ] } }, + "/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" + ] + } + }, "/connection-test/ping": { "post": { "operationId": "ConnectionTestController_connectionTestPing", @@ -1542,6 +4398,20 @@ ] } }, + "/oauth/hubspot/callback": { + "get": { + "operationId": "OauthController_oauthHubspotCallback", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "oauth" + ] + } + }, "/oauth/googleads": { "get": { "operationId": "OauthController_oauthGoogleAds", @@ -1563,6 +4433,20 @@ ] } }, + "/oauth/googleads/callback": { + "get": { + "operationId": "OauthController_oauthGoogleAdsCallback", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "oauth" + ] + } + }, "/oauth/google-sheets": { "get": { "operationId": "OauthController_oauthGoogleSheets", @@ -1584,6 +4468,20 @@ ] } }, + "/oauth/google-sheets/callback": { + "get": { + "operationId": "OauthController_oauthGoogleSheetsCallback", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "oauth" + ] + } + }, "/oauth/facebook": { "get": { "operationId": "OauthController_oauthFacebook", @@ -1605,6 +4503,20 @@ ] } }, + "/oauth/facebook/callback": { + "get": { + "operationId": "OauthController_oauthFacebookCallback", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "oauth" + ] + } + }, "/oauth/mailchimp": { "get": { "operationId": "OauthController_oauthMailchimp", @@ -1626,6 +4538,20 @@ ] } }, + "/oauth/mailchimp/callback": { + "get": { + "operationId": "OauthController_oauthMailchimpCallback", + "parameters": [], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "oauth" + ] + } + }, "/oauth/salesforce": { "get": { "operationId": "OauthController_oauthSalesforce", @@ -1647,6 +4573,72 @@ ] } }, + "/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" + ], + "security": [ + { + "access-token": [] + } + ] + } + }, + "/trackEvent/{id}": { + "post": { + "operationId": "MixpanelController_trackEvent", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "security": [ + { + "access-token": [] + } + ] + } + }, "/health": { "get": { "operationId": "HealthController_check", @@ -1669,7 +4661,20 @@ "contact": {} }, "tags": [], - "servers": [], + "servers": [ + { + "url": "https://maestro.stg.dadosfera.ai", + "description": "Ambiente STG" + }, + { + "url": "https://maestro-2.stg.dadosfera.ai", + "description": "Ambiente STG2" + }, + { + "url": "https://maestro.dadosfera.ai", + "description": "Ambiente PRD" + } + ], "components": { "securitySchemes": { "access-token": { @@ -2107,6 +5112,975 @@ "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" + ] + }, + "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" + ] + }, + "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" + ] + }, "NetworkConfigToCatalogDto": { "type": "object", "properties": { @@ -2211,6 +6185,38 @@ "network_config" ] }, + "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": { @@ -2436,6 +6442,74 @@ "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" + ] + }, "IRole": { "type": "object", "properties": { @@ -3220,6 +7294,28 @@ "operation_result", "tables_metadata" ] + }, + "INote": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "content": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "title", + "content", + "tags" + ] } } }