gitea_admin/maestro
1
0
Fork 0
mirror of https://github.com/dadosfera/maestro.git synced 2026-08-31 19:58:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
maestro/docsfera.json
T
marcos.rodrigues e3a2eba5c3 Merge pull request #515 from dadosfera/release/2026-08-27-beta 
Release/2026 08 27 beta
2026-08-27 16:09:16 -03:00

12045 lines
284 KiB
JSON
Raw Permalink Blame History

{
"service": "${DOCS_API_TOKEN}",
"pageId": "${DOCS_PAGE_ID}",
"blockId": "${DOCS_BLOCK_ID}",
"schema": {
"openapi": "3.0.0",
"paths": {
"/auth/sign-in": {
"post": {
"operationId": "AuthController_signIn",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthSignInReq"
}
}
}
},
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Auth"
]
}
},
"/auth/sign-out": {
"post": {
"operationId": "AuthController_signOut",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
}
},
"tags": [
"Auth"
]
}
},
"/auth/refresh-access-token": {
"post": {
"operationId": "AuthController_refreshAccessToken",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "origin",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthRefreshAccessTokenReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthRefreshAccessTokenRes"
}
}
}
}
},
"tags": [
"Auth"
]
}
},
"/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": ""
}
},
"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"
}
},
{
"name": "origin",
"required": true,
"in": "header",
"schema": {
"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"
]
}
},
"/auth/users/block": {
"post": {
"operationId": "AuthController_blockUsers",
"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/users/unblock": {
"post": {
"operationId": "AuthController_unblockUsers",
"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/users/reset": {
"post": {
"operationId": "AuthController_resetUsers",
"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/me": {
"get": {
"operationId": "AuthController_getMe",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Auth"
]
}
},
"/api-key": {
"post": {
"operationId": "ApiKeyController_create",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyResponseDto"
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyResponseDto"
}
}
}
}
},
"tags": [
"ApiKey"
],
"security": [
{
"access-token": []
}
]
},
"get": {
"operationId": "ApiKeyController_findAll",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKeyBaseResponseDto"
}
}
}
}
},
"default": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKeyBaseResponseDto"
}
}
}
}
}
},
"tags": [
"ApiKey"
],
"security": [
{
"access-token": []
}
]
}
},
"/api-key/{id}": {
"delete": {
"operationId": "ApiKeyController_remove",
"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": [
"ApiKey"
],
"security": [
{
"access-token": []
}
]
}
},
"/connections": {
"post": {
"operationId": "ConnectionController_createConnection",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConnectionDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRes"
}
}
}
}
},
"tags": [
"connections"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "ConnectionController_getAllConnections",
"parameters": [
{
"name": "search",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "size",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionsRes"
}
}
}
}
},
"tags": [
"connections"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/connections/{id}": {
"put": {
"operationId": "ConnectionController_updateConnection",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConnectionDto"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRes"
}
}
}
}
},
"tags": [
"connections"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "ConnectionController_deleteConnection",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRes"
}
}
}
}
},
"tags": [
"connections"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "ConnectionController_getConnectionDetails",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionDetailsRes"
}
}
}
}
},
"tags": [
"connections"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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/download": {
"get": {
"operationId": "UsersController_downloadUsersInCsv",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"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": []
}
]
}
},
"/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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"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": []
},
{
"access-token": []
}
]
}
},
"/network-config": {
"get": {
"operationId": "NetworkConfigController_findAllNetworkConfigs",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
}
}
}
}
},
"tags": [
"Network Config"
],
"security": [
{
"access-token": []
}
]
},
"post": {
"operationId": "NetworkConfigController_createNetworkConfigs",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CreateNetworkConfigReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNetworkConfigRes"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNetworkConfigRes"
}
}
}
}
},
"tags": [
"Network Config"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/network-config/{id}": {
"get": {
"operationId": "NetworkConfigController_findNetworkConfigById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
}
}
}
}
},
"tags": [
"Network Config"
],
"security": [
{
"access-token": []
}
]
}
},
"/network-config/{id}/details": {
"get": {
"operationId": "NetworkConfigController_findNetworkConfigByIdDetails",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
}
}
}
}
},
"tags": [
"Network Config"
],
"security": [
{
"access-token": []
}
]
}
},
"/inputs/available-entities/{plugin}": {
"get": {
"operationId": "InputsController_getAvailableEntities",
"parameters": [
{
"name": "plugin",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAvailableEntitiesRes"
}
}
}
}
},
"tags": [
"Inputs"
],
"security": [
{
"access-token": []
}
]
}
},
"/inputs": {
"post": {
"operationId": "InputsController_create",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInputReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Input"
}
}
}
},
"201": {
"description": ""
}
},
"tags": [
"Inputs"
],
"security": [
{
"access-token": []
}
]
},
"get": {
"operationId": "InputsController_findAll",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Inputs"
],
"security": [
{
"access-token": []
}
]
}
},
"/inputs/{id}": {
"get": {
"operationId": "InputsController_findOne",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Inputs"
],
"security": [
{
"access-token": []
}
]
},
"patch": {
"operationId": "InputsController_update",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"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/monitoring-dashboard": {
"get": {
"operationId": "PipelinesController_getMonitoringDashboard",
"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": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2": {
"post": {
"operationId": "PipelinesController_create",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ICreatePipelineV2Req"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPipelineV2"
}
}
}
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "PipelinesController_findAll",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "size",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/download-logs": {
"get": {
"operationId": "PipelinesController_downloadLogs",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "pipeline_run_id",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}/config": {
"get": {
"operationId": "PipelinesController_getPipelineproperties",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}/objects": {
"get": {
"operationId": "PipelinesController_getPipelineObjects",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}/status": {
"get": {
"operationId": "PipelinesController_getPipelineStatus",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}": {
"get": {
"operationId": "PipelinesController_findOne",
"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": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"patch": {
"operationId": "PipelinesController_update",
"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": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"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"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "PipelinesController_delete",
"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": {
"204": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}/data-assets": {
"get": {
"operationId": "PipelinesController_findAllDataAssetByPipeline",
"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"
}
},
{
"name": "object",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{pipelineId}/inputs/{id}": {
"patch": {
"operationId": "PipelinesController_updatePipelineInput",
"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"
}
},
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/pipelinesV2/{id}/upgrade": {
"patch": {
"operationId": "PipelinesController_upgradeConnector",
"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": {
"204": {
"description": ""
}
},
"tags": [
"PipelinesV2"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"PipelinesV2"
],
"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": [
{
"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": []
}
]
},
"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": []
}
]
}
},
"/platform/pipelines": {
"post": {
"operationId": "PlatformApiController_createPipeline",
"summary": "Create a new pipeline",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "PlatformApiController_getPipelines",
"summary": "List all pipelines for customer",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}": {
"get": {
"operationId": "PlatformApiController_getPipeline",
"summary": "Get pipeline by ID",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"patch": {
"operationId": "PlatformApiController_updatePipeline",
"summary": "Update pipeline by ID",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "PlatformApiController_deletePipeline",
"summary": "Delete pipeline by ID",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/execute": {
"post": {
"operationId": "PlatformApiController_executePipeline",
"summary": "Execute a pipeline",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/pause": {
"post": {
"operationId": "PlatformApiController_pausePipeline",
"summary": "Pause a pipeline",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/unpause": {
"post": {
"operationId": "PlatformApiController_unpausePipeline",
"summary": "Unpause a pipeline",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/memory": {
"put": {
"operationId": "PlatformApiController_updatePipelineMemory",
"summary": "Update pipeline memory configuration",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/metadata": {
"put": {
"operationId": "PlatformApiController_updatePipelineMetadata",
"summary": "Update pipeline metadata",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/metadata": {
"get": {
"operationId": "PlatformApiController_getPipelinesMetadata",
"summary": "Get all pipelines metadata",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/catalog/schemas": {
"get": {
"operationId": "PlatformApiController_getAvailableSchemas",
"summary": "Get available schemas",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/catalog/tables/validate": {
"post": {
"operationId": "PlatformApiController_validateTableAndSchema",
"summary": "Validate Table and Schema",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationTableDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/pipeline_run": {
"get": {
"operationId": "PlatformApiController_getPipelineRuns",
"summary": "Get pipeline runs for a pipeline",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/pipeline_run/{runId}": {
"get": {
"operationId": "PlatformApiController_getPipelineRun",
"summary": "Get specific pipeline run",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "runId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/pipeline_run/{runId}/logs": {
"get": {
"operationId": "PlatformApiController_getPipelineRunLogs",
"summary": "Get pipeline run logs",
"parameters": [
{
"name": "runId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/pipeline_run/{runId}/cancel": {
"post": {
"operationId": "PlatformApiController_cancelPipelineRun",
"summary": "Cancel a running pipeline run",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "runId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/pipeline_run/{runId}/jobs": {
"get": {
"operationId": "PlatformApiController_getPipelineRunJobs",
"summary": "Get pipeline run jobs",
"description": "Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "runId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DB-backed job runs for the selected pipeline run.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"jobs"
]
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
}
]
}
},
"/platform/jobs/{jobId}/input": {
"put": {
"operationId": "PlatformApiController_updateJobInput",
"summary": "Update job input columns",
"parameters": [
{
"name": "jobId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"patch": {
"operationId": "PlatformApiController_patchJobInput",
"summary": "Partial update job input columns",
"parameters": [
{
"name": "jobId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/jobs/{jobId}/memory": {
"put": {
"operationId": "PlatformApiController_updateJobMemory",
"summary": "Update job memory configuration",
"parameters": [
{
"name": "jobId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/jobs/{jobId}/reset-state": {
"post": {
"operationId": "PlatformApiController_resetJobState",
"summary": "Reset job state",
"parameters": [
{
"name": "jobId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/pipelines/{pipelineId}/inputs/{inputId}": {
"delete": {
"operationId": "PlatformApiController_deleteTable",
"summary": "Mark a table as deleted and delete its associated job via platform-api",
"parameters": [
{
"name": "pipelineId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "inputId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/jobs/jdbc/configs/allowed_datatypes": {
"get": {
"operationId": "PlatformApiController_getJdbcAllowedDatatypes",
"summary": "Get allowed datatypes for JDBC",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/platform/health": {
"get": {
"operationId": "PlatformApiController_healthCheck",
"summary": "Platform API health check",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Platform API"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/{id}/mfa": {
"post": {
"operationId": "CustomersController_enableMfaEnforce",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnforceMfa"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/{id}/links": {
"get": {
"operationId": "CustomersController_getCustomerLinks",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerLinksResponse"
}
}
}
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
}
]
},
"put": {
"operationId": "CustomersController_setCustomerLinks",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerLinkRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/token": {
"get": {
"operationId": "CustomersController_getCustomerToken",
"parameters": [
{
"name": "exp",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/monitoring-dashboard": {
"get": {
"operationId": "CustomersController_getCustomerMonitoringDashboard",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/logs-dashboard": {
"get": {
"operationId": "CustomersController_getCustomerMixPanelLogsDashboard",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/access-dashboard": {
"get": {
"operationId": "CustomersController_getAccessDashboard",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/customers/{id}/organization-info": {
"get": {
"operationId": "CustomersController_getOrganizationInfo",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Organization information"
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"put": {
"operationId": "CustomersController_updateOrganizationInfo",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Organization information updated"
}
},
"tags": [
"Customers"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog": {
"get": {
"operationId": "CatalogController_searchCatalog",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Número de registros a ser retornado",
"schema": {
"minimum": 1,
"maximum": 10000,
"type": "number"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Usado para paginação, em conjunto com `size`",
"schema": {
"minimum": 1,
"type": "number"
}
},
{
"name": "sort_by",
"required": false,
"in": "query",
"description": "Campo do data asset para usar na ordenação. Padrão: `created_at` ",
"schema": {
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Tipo de ordenação - `asc`: crescente; `desc`: decrescente ",
"schema": {
"default": "asc",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "owner",
"required": false,
"in": "query",
"description": "ID do usuário owner para filtrar data assets",
"example": "user-id-1,user-id-2",
"schema": {
"type": "string"
}
},
{
"name": "catalog_date_from",
"required": false,
"in": "query",
"description": "Data inicial para filtro de catálogo (formato: YYYY-MM-DD)",
"example": "2025-01-01",
"schema": {
"type": "string"
}
},
{
"name": "catalog_date_to",
"required": false,
"in": "query",
"description": "Data final para filtro de catálogo (formato: YYYY-MM-DD)",
"example": "2025-12-31",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ICatalogAllResponse"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"post": {
"operationId": "CatalogController_createDataAsset",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ICreateDataAsset"
}
}
}
},
"responses": {
"201": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/download": {
"get": {
"operationId": "CatalogController_dowloadAsserts",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Número de registros a ser retornado",
"schema": {
"minimum": 1,
"maximum": 10000,
"type": "number"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Usado para paginação, em conjunto com `size`",
"schema": {
"minimum": 1,
"type": "number"
}
},
{
"name": "sort_by",
"required": false,
"in": "query",
"description": "Campo do data asset para usar na ordenação. Padrão: `created_at` ",
"schema": {
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Tipo de ordenação - `asc`: crescente; `desc`: decrescente ",
"schema": {
"default": "asc",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "owner",
"required": false,
"in": "query",
"description": "ID do usuário owner para filtrar data assets",
"example": "user-id-1,user-id-2",
"schema": {
"type": "string"
}
},
{
"name": "catalog_date_from",
"required": false,
"in": "query",
"description": "Data inicial para filtro de catálogo (formato: YYYY-MM-DD)",
"example": "2025-01-01",
"schema": {
"type": "string"
}
},
{
"name": "catalog_date_to",
"required": false,
"in": "query",
"description": "Data final para filtro de catálogo (formato: YYYY-MM-DD)",
"example": "2025-12-31",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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": []
},
{
"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": []
},
{
"access-token": []
}
]
}
},
"/catalog/schemas": {
"get": {
"operationId": "CatalogController_findSchemas",
"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/custom-properties": {
"get": {
"operationId": "CatalogController_getCustomPropertyDefinitions",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}": {
"get": {
"operationId": "CatalogController_getDataAsset",
"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"
}
},
{
"name": "shared",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"put": {
"operationId": "CatalogController_updateDataAsset",
"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/IUpdateDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IOneDataAsset"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "CatalogController_deleteDataAsset",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}/columns-metadata": {
"get": {
"operationId": "CatalogController_getDataAssetColumnsMetadata",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IColumnsMetadataResponse"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}/preview": {
"get": {
"operationId": "CatalogController_getDataAssetPreview",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPreviewResponse"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}/docs": {
"get": {
"operationId": "CatalogController_getDataAssetDocs",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "asset_type",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IDocsResponse"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"post": {
"operationId": "CatalogController_manageDataAssetDocs",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "asset_type",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}/certification-status": {
"put": {
"operationId": "CatalogController_updateDataAssetCertificationStatus",
"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/IUpdateCertificationStatusRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IUpdateCertificationStatusRequest"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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": []
},
{
"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": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/{id}/comment": {
"post": {
"operationId": "CatalogController_commentOnDataAsset",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IMakeAComment"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "CatalogController_deleteComment",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IDeleteComment"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/dataset-catalog-task": {
"post": {
"operationId": "CatalogController_triggerCatalog",
"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/TriggerCatalogReq"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerCatalogRes"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/dataset-catalog-task/{session}": {
"get": {
"operationId": "CatalogController_getCatalogTask",
"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": {
"$ref": "#/components/schemas/GetDatasetCatalogTaskRes"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/rls-rule": {
"post": {
"operationId": "CatalogController_addRlsRule",
"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": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "CatalogController_getRlsRules",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "CatalogController_batchRemoveRlsRules",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "nimbus_dashboard_id",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "id_rls",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/rls-rule/{id}": {
"get": {
"operationId": "CatalogController_getOneRlsRule",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "CatalogController_removeRlsRule",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/nimbus-dashboards": {
"get": {
"operationId": "CatalogController_getNimbusDashboards",
"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": []
},
{
"access-token": []
}
]
}
},
"/catalog/register-dataset": {
"post": {
"operationId": "CatalogController_registerDatasetWithMetadataRequest",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
}
],
"responses": {
"201": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/pii-reporter": {
"get": {
"operationId": "CatalogController_getPiiReporter",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "type",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Catalog"
],
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/catalog/data-asset/share/{id}": {
"get": {
"operationId": "ShareController_getShareDataAsset",
"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"
]
}
},
"/catalog/data-asset/share/{id}/columns-metadata": {
"get": {
"operationId": "ShareController_getShareDataAssetColumnsMetadata",
"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/IColumnsMetadataResponse"
}
}
}
}
},
"tags": [
"Catalog"
]
}
},
"/catalog/data-asset/share/{id}/preview": {
"get": {
"operationId": "ShareController_getShareDataAssetPreview",
"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/IPreviewResponse"
}
}
}
}
},
"tags": [
"Catalog"
]
}
},
"/catalog/data-asset/share/{id}/docs": {
"get": {
"operationId": "ShareController_getShareDataAssetDocs",
"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/IDocsResponse"
}
}
}
}
},
"tags": [
"Catalog"
]
}
},
"/share": {
"put": {
"operationId": "ShareMetadataController_findOrcreate",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShareMetadataDto"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
}
]
},
"patch": {
"operationId": "ShareMetadataController_updateShareType",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShareMetadataDto"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
}
]
}
},
"/share/{id}": {
"get": {
"operationId": "ShareMetadataController_get",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
}
]
}
},
"/trackEvent/{id}": {
"post": {
"operationId": "MixpanelController_trackEvent",
"parameters": [],
"responses": {
"201": {
"description": ""
}
}
}
},
"/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",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestPingReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestPingRes"
}
}
}
}
},
"tags": [
"Connection Test"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/connection-test/credentials": {
"post": {
"operationId": "ConnectionTestController_connectionTestCredentials",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestCredentialsReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestCredentialsRes"
}
}
}
}
},
"tags": [
"Connection Test"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/connection-test/schemas": {
"post": {
"operationId": "ConnectionTestController_connectionTestListSchemas",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestListSchemasReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestListSchemasRes"
}
}
}
}
},
"tags": [
"Connection Test"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/connection-test/tables": {
"post": {
"operationId": "ConnectionTestController_connectionTestListTables",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestListTablesReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestListTablesRes"
}
}
}
}
},
"tags": [
"Connection Test"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/connection-test/table-metadata": {
"post": {
"operationId": "ConnectionTestController_getTableMetadata",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTableMetadataReq"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTableMetadataRes"
}
}
}
}
},
"tags": [
"Connection Test"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/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"
],
"security": [
{
"access-token": []
}
]
}
},
"/open-data/sharing-ocean-data": {
"post": {
"operationId": "OpenDataController_createUser",
"parameters": [
{
"name": "dadosfera-lang",
"in": "header",
"required": false,
"schema": {
"enum": [
"pt-br",
"en-us"
],
"type": "string"
}
},
{
"name": "language",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "origin",
"required": true,
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"OpenData"
]
}
},
"/customers/{id}/theme": {
"post": {
"operationId": "ThemeController_saveCustomertheme",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerThemeRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerThemeResponse"
}
}
}
}
},
"tags": [
"Theme"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "ThemeController_getCustomerTheme",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerThemeResponse"
}
}
}
}
},
"tags": [
"Theme"
]
}
},
"/customers/{id}/theme/reset": {
"post": {
"operationId": "ThemeController_resetTheme",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerThemeResponse"
}
}
}
},
"201": {
"description": ""
}
},
"tags": [
"Theme"
]
}
},
"/network-policy": {
"get": {
"operationId": "NetworkPolicyController_getNetworks",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPoliciesDTO"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"post": {
"operationId": "NetworkPolicyController_applyNetworkPolicies",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPoliciesDTO"
}
}
}
},
"responses": {
"200": {
"description": ""
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"delete": {
"operationId": "NetworkPolicyController_removeNetworkPolicies",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPoliciesDTO"
}
}
}
},
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/assign/public-key": {
"put": {
"operationId": "AssignController_create",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAssignDto"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "AssignController_get",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/identity-providers": {
"post": {
"operationId": "IdentityProviderController_addIdentityProvider",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIdentityProvider"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProviderResponse"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "IdentityProviderController_getProviders",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProviderListResponse"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/identity-providers/{id}": {
"delete": {
"operationId": "IdentityProviderController_deleteIdentityProvider",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"put": {
"operationId": "IdentityProviderController_updateIdentityProviders",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIdentityProvider"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
},
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "IdentityProviderController_loginIdp",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/identity-providers/callback": {
"post": {
"operationId": "IdentityProviderController_callbackIdp",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/identity-providers/links": {
"get": {
"operationId": "IdentityProviderController_providerLinks",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/storage-explorer/tables/validate-name": {
"post": {
"operationId": "StorageExplorerController_validateTableName",
"summary": "Validate table name in PostgreSQL and Snowflake",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables": {
"post": {
"operationId": "StorageExplorerController_createTable",
"summary": "Create a new table",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
},
"get": {
"operationId": "StorageExplorerController_listTables",
"summary": "List all tables with pagination",
"parameters": [
{
"name": "page",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables/{tableId}": {
"get": {
"operationId": "StorageExplorerController_getTable",
"summary": "Get table details by ID",
"parameters": [
{
"name": "tableId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables/{tableId}/datasets/{datasetId}": {
"post": {
"operationId": "StorageExplorerController_linkDatasetToTable",
"summary": "Link a dataset to a table",
"parameters": [
{
"name": "tableId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "datasetId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables/{tableId}/datasets": {
"get": {
"operationId": "StorageExplorerController_getTableDatasets",
"summary": "Get all datasets linked to a table",
"parameters": [
{
"name": "tableId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables/{tableId}/schema": {
"get": {
"operationId": "StorageExplorerController_getTableSchema",
"summary": "Get table schema",
"parameters": [
{
"name": "tableId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/tables/{tableId}/validate-compatibility/{datasetId}": {
"post": {
"operationId": "StorageExplorerController_validateSchemaCompatibility",
"summary": "Validate schema compatibility between table and dataset",
"parameters": [
{
"name": "tableId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "datasetId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/datasets/{datasetId}/preview": {
"get": {
"operationId": "StorageExplorerController_getDatasetPreview",
"summary": "Get dataset preview data",
"parameters": [
{
"name": "datasetId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/datasets/{datasetId}/schema": {
"get": {
"operationId": "StorageExplorerController_getDatasetSchema",
"summary": "Get dataset schema information",
"parameters": [
{
"name": "datasetId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "force_refresh",
"required": true,
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/datasets/upload/{uploadId}": {
"get": {
"operationId": "StorageExplorerController_listDatasetsByUpload",
"summary": "List all datasets for a specific upload",
"parameters": [
{
"name": "uploadId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/datasets/{datasetId}/refresh-schema": {
"put": {
"operationId": "StorageExplorerController_refreshDatasetSchema",
"summary": "Refresh dataset schema with new parsing options (Excel)",
"parameters": [
{
"name": "datasetId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/uploads/history": {
"get": {
"operationId": "StorageExplorerController_listFileExplorerUploads",
"summary": "List file explorer uploads with pagination",
"parameters": [
{
"name": "page",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "limit",
"required": true,
"in": "query",
"schema": {
"type": "number"
}
},
{
"name": "folder_path",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/browse": {
"get": {
"operationId": "StorageExplorerController_browseStorage",
"summary": "Browse folders and files in storage",
"parameters": [
{
"name": "path",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/upload/batch": {
"post": {
"operationId": "StorageExplorerController_batchUpload",
"summary": "Upload multiple files to storage",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/folder/create": {
"post": {
"operationId": "StorageExplorerController_createFolder",
"summary": "Create a new folder in storage",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/download": {
"get": {
"operationId": "StorageExplorerController_downloadFile",
"summary": "Download a file from storage",
"parameters": [
{
"name": "file_path",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/storage-explorer/storage/metadata": {
"get": {
"operationId": "StorageExplorerController_getFileMetadata",
"summary": "Get detailed file metadata",
"parameters": [
{
"name": "file_path",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"tags": [
"Storage Explorer"
],
"security": [
{
"access-token": []
},
{
"access-token": []
}
]
}
},
"/health": {
"get": {
"operationId": "HealthController_check",
"parameters": [],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"Health"
]
}
},
"/release_note": {
"get": {
"operationId": "ReleaseNoteController_getLatestReleaseNote",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"access-token": []
}
]
}
}
},
"info": {
"title": "Maestro",
"description": "This is the Maestro API",
"version": "1.0.0",
"contact": {}
},
"tags": [],
"servers": [],
"components": {
"securitySchemes": {
"access-token": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
},
"schemas": {
"AuthSignInReq": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"totp": {
"type": "string",
"description": "TOTP code used to login when Multi-Factor Authentication is enabled"
}
},
"required": [
"username",
"password"
]
},
"AuthRefreshAccessTokenReq": {
"type": "object",
"properties": {
"refreshToken": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"refreshToken",
"userId"
]
},
"AuthRefreshAccessTokenRes": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"accessToken": {
"type": "string"
}
},
"required": [
"permissions",
"accessToken"
]
},
"CreateApiKeyDto": {
"type": "object",
"properties": {
"permissions": {
"description": "Array of permission IDs",
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"permissions"
]
},
"PermissionDto": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"CreateApiKeyResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"key_mask": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionDto"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"id",
"key_mask",
"permissions",
"created_at",
"created_by",
"key"
]
},
"ApiKeyBaseResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"key_mask": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionDto"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
}
},
"required": [
"id",
"key_mask",
"permissions",
"created_at",
"created_by"
]
},
"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": {
"id": {
"type": "string"
},
"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"
]
},
"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"
},
"bio": {
"type": "string"
},
"companyName": {
"type": "string"
},
"personalSite": {
"type": "string"
},
"mfaStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"lastLogin": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"authProvider": {
"type": "string"
}
},
"required": [
"id",
"name",
"email",
"roles",
"jobTitle",
"department",
"hierarchy",
"bio",
"companyName",
"personalSite",
"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"
},
"bio": {
"type": "string"
},
"companyName": {
"type": "string"
},
"personalSite": {
"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",
"bio",
"companyName",
"personalSite",
"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"
},
"bio": {
"type": "string"
},
"personalSite": {
"type": "string"
},
"companyName": {
"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"
},
"bio": {
"type": "string"
},
"companyName": {
"type": "string"
},
"personalSite": {
"type": "string"
},
"mfaStatus": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"status": {
"type": "string"
},
"lastLogin": {
"type": "string"
}
},
"required": [
"id",
"name",
"email",
"jobTitle",
"department",
"hierarchy",
"bio",
"companyName",
"personalSite",
"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": {
"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"
]
},
"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"
]
},
"Column": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
]
},
"TableColumns": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"columns": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Column"
}
},
"destination": {
"type": "object"
},
"type": {
"type": "string"
},
"identifier_columns": {
"type": "array",
"items": {
"type": "string"
}
},
"reference_column": {
"$ref": "#/components/schemas/Column"
}
},
"required": [
"name",
"columns",
"destination",
"type"
]
},
"CreateInputReq": {
"type": "object",
"properties": {
"tables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableColumns"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"plugin": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"tables",
"name",
"description",
"plugin"
]
},
"Input": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"tables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableColumns"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"plugin": {
"type": "string"
},
"type": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"tables",
"name",
"description",
"plugin",
"created_at",
"updated_at"
]
},
"ICreatePipelineV2Req": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"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",
"type",
"connection_id",
"cron",
"connector_name",
"connector_plugin",
"connector_version",
"image_url"
]
},
"IPipelineV2": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"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",
"type",
"connection_id",
"cron",
"connector_name",
"connector_plugin",
"connector_version",
"image_url",
"created_at",
"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"
},
"engine": {
"type": "string"
}
},
"required": [
"name",
"file_name",
"description",
"encoding",
"sep",
"header",
"engine"
]
},
"ValidationTableDTO": {
"type": "object",
"properties": {
"tables": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"tables"
]
},
"EnforceMfa": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
]
},
"CustomerLinkItem": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"iconSrc": {
"type": "string"
}
},
"required": [
"href",
"name",
"description"
]
},
"CustomerSidebarSection": {
"type": "object",
"properties": {
"title": {
"type": "object"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerSidebarMenuItem"
},
{
"$ref": "#/components/schemas/CustomerSidebarLinkItem"
}
]
}
}
},
"required": [
"title",
"items"
]
},
"CustomerLinksConfig": {
"type": "object",
"properties": {
"home": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerLinkItem"
}
},
"sidebar": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerSidebarSection"
}
}
}
},
"CustomerLinksResponse": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/CustomerLinksConfig"
}
}
},
"CustomerLinkRequest": {
"type": "object",
"properties": {
"links": {
"$ref": "#/components/schemas/CustomerLinksConfig"
}
},
"required": [
"links"
]
},
"IRole": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"name",
"id"
]
},
"IUser": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"username",
"id"
]
},
"IComment": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"message": {
"type": "string"
},
"created_at": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"message",
"created_at",
"username"
]
},
"EmbedObject": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
]
},
"IDataAsset": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"database_name": {
"type": "string"
},
"table_name": {
"type": "string"
},
"num_columns": {
"type": "number"
},
"location": {
"type": "string"
},
"created_time": {
"type": "string"
},
"table_type": {
"type": "string"
},
"size_in_bytes": {
"type": "number"
},
"num_files": {
"type": "number"
},
"data_encrypted": {
"type": "string"
},
"num_rows": {
"type": "number"
},
"display_name": {
"type": "string"
},
"pipeline_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"description": {
"type": "string"
},
"data_asset_type": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IRole"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IUser"
}
},
"dashboard_id": {
"type": "number"
},
"name": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "string"
}
},
"embedding_params": {
"type": "object"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IComment"
}
},
"embed": {
"$ref": "#/components/schemas/EmbedObject"
},
"share_type": {
"type": "string",
"enum": [
"none",
"public",
"private"
]
},
"docs": {
"type": "string"
}
},
"required": [
"id",
"display_name",
"pipeline_id",
"user_id",
"description",
"data_asset_type",
"tags",
"owner",
"roles",
"users",
"created_at",
"comments"
]
},
"ICatalogAllResponse": {
"type": "object",
"properties": {
"data_assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IDataAsset"
}
},
"total": {
"type": "number"
}
},
"required": [
"data_assets",
"total"
]
},
"IColumnMetadata": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"table_name": {
"type": "string"
},
"column_name": {
"type": "string"
},
"data_type": {
"type": "string"
},
"missing_count": {
"type": "string"
},
"min": {
"type": "string"
},
"max": {
"type": "string"
},
"count": {
"type": "string"
},
"histogram": {
"type": "string"
},
"mean": {
"type": "string"
},
"median": {
"type": "string"
},
"missing_rate": {
"type": "string"
},
"stddev": {
"type": "string"
},
"unique_count": {
"type": "string"
},
"unique_rate": {
"type": "string"
},
"analyzer_rules": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "string"
}
},
"required": [
"id",
"table_name",
"column_name",
"data_type",
"missing_count",
"min",
"max",
"count",
"histogram",
"mean",
"median",
"missing_rate",
"stddev",
"unique_count",
"unique_rate",
"analyzer_rules",
"version"
]
},
"IColumnsMetadataResponse": {
"type": "object",
"properties": {
"columns_metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IColumnMetadata"
}
}
},
"required": [
"columns_metadata"
]
},
"IData": {
"type": "object",
"properties": {
"var": {
"type": "number"
},
"date": {
"type": "string"
},
"last": {
"type": "number"
},
"maximum": {
"type": "number"
},
"minimum": {
"type": "number"
},
"day_opening": {
"type": "number"
}
},
"required": [
"var",
"date",
"last",
"maximum",
"minimum",
"day_opening"
]
},
"IPreview": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"database_name": {
"type": "string"
},
"table_name": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IData"
}
}
},
"required": [
"id",
"database_name",
"table_name",
"data"
]
},
"IPreviewResponse": {
"type": "object",
"properties": {
"preview": {
"$ref": "#/components/schemas/IPreview"
}
},
"required": [
"preview"
]
},
"IDocs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docs": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"table_id": {
"type": "string"
}
},
"required": [
"id",
"docs",
"updated_at",
"table_id"
]
},
"IDocsResponse": {
"type": "object",
"properties": {
"docs": {
"$ref": "#/components/schemas/IDocs"
}
},
"required": [
"docs"
]
},
"CustomPropertyDto": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"text",
"number",
"date",
"boolean"
]
},
"color": {
"type": "string"
},
"emoji": {
"type": "string"
}
},
"required": [
"key",
"value",
"type"
]
},
"IUpdateDataRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"embed": {
"$ref": "#/components/schemas/EmbedObject"
},
"share_type": {
"type": "string",
"enum": [
"none",
"public",
"private"
]
},
"docs": {
"type": "string"
},
"custom_properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomPropertyDto"
}
}
},
"required": [
"name",
"description",
"tags"
]
},
"IOneDataAsset": {
"type": "object",
"properties": {
"data_asset": {
"$ref": "#/components/schemas/IDataAsset"
}
},
"required": [
"data_asset"
]
},
"IUpdateCertificationStatusRequest": {
"type": "object",
"properties": {
"certification_status": {
"type": "string",
"enum": [
"draft",
"in_review",
"approved",
"deprecated"
]
}
},
"required": [
"certification_status"
]
},
"ICreateDataAsset": {
"type": "object",
"properties": {
"display_name": {
"type": "string"
},
"description": {
"type": "string"
},
"data_asset_type": {
"type": "string"
},
"external_url": {
"type": "string"
},
"location": {
"type": "string"
},
"embed": {
"$ref": "#/components/schemas/EmbedObject"
},
"docs": {
"type": "string"
}
},
"required": [
"display_name",
"description",
"data_asset_type",
"external_url",
"location"
]
},
"IMakeAComment": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"CommentToDelete": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
]
},
"IDeleteComment": {
"type": "object",
"properties": {
"comment": {
"$ref": "#/components/schemas/CommentToDelete"
}
},
"required": [
"comment"
]
},
"TriggerCatalogReq": {
"type": "object",
"properties": {
"table_name": {
"type": "string",
"description": "Name of the table on Snowflake",
"example": "TB__4DXSD4_TEST"
},
"table_schema": {
"type": "string",
"description": "Schema where the asset is located. If not set defaults to \"PUBLIC\""
},
"pipeline_id": {
"type": "string",
"description": "Id of the pipeline that generated the asset."
}
},
"required": [
"table_name"
]
},
"TriggerCatalogRes": {
"type": "object",
"properties": {
"session": {
"type": "string"
}
},
"required": [
"session"
]
},
"GetDatasetCatalogTaskRes": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"session_id": {
"type": "string"
},
"status": {
"type": "string"
},
"table_name": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
}
},
"required": [
"created_at",
"customer_name",
"session_id",
"status",
"table_name",
"updated_at",
"updated_by"
]
},
"CreateShareMetadataDto": {
"type": "object",
"properties": {
"assetId": {
"type": "string"
},
"proposedId": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"assetId",
"proposedId",
"type"
]
},
"UpdateShareMetadataDto": {
"type": "object",
"properties": {
"shareId": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"shareId",
"type"
]
},
"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"
]
},
"INote": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"title",
"content",
"tags"
]
},
"CustomerThemeRequest": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"textColor": {
"type": "string"
}
},
"required": [
"displayName",
"backgroundColor",
"textColor"
]
},
"CustomerTheme": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"textColor": {
"type": "string"
},
"logo": {
"type": "string"
},
"logoLogin": {
"type": "string"
}
},
"required": [
"backgroundColor",
"textColor",
"logo",
"logoLogin"
]
},
"CustomerThemeResponse": {
"type": "object",
"properties": {
"theme": {
"$ref": "#/components/schemas/CustomerTheme"
}
},
"required": [
"theme"
]
},
"NetworkPoliciesDTO": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"policies"
]
},
"CreateAssignDto": {
"type": "object",
"properties": {
"publicKey": {
"type": "string"
}
},
"required": [
"publicKey"
]
},
"CreateIdentityProvider": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuerUrl": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"name",
"clientId",
"clientSecret",
"issuerUrl",
"permissions"
]
},
"IdentityProviderResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"clientId": {
"type": "string"
},
"issueUrl": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"name",
"clientId",
"issueUrl",
"permissions"
]
},
"IdentityProviderListResponse": {
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProviderResponse"
}
}
},
"required": [
"providers"
]
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink