mirror of
https://github.com/dadosfera/maestro.git
synced 2026-08-31 19:58:21 +00:00
3360 lines
79 KiB
JSON
3360 lines
79 KiB
JSON
{
|
|
"service": "${DOCS_API_TOKEN}",
|
|
"pageId": "${DOCS_PAGE_ID}",
|
|
"blockId": "${DOCS_BLOCK_ID}",
|
|
"schema": {
|
|
"openapi": "3.0.0",
|
|
"paths": {
|
|
"/auth/sign-in": {
|
|
"post": {
|
|
"operationId": "AuthController_signIn",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AuthSignInReq"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AuthSignInRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Auth"
|
|
]
|
|
}
|
|
},
|
|
"/auth/refresh-access-token": {
|
|
"post": {
|
|
"operationId": "AuthController_refreshAccessToken",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AuthRefreshAccessTokenReq"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AuthRefreshAccessTokenRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Auth"
|
|
]
|
|
}
|
|
},
|
|
"/connections": {
|
|
"post": {
|
|
"operationId": "ConnectionController_createConnection",
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateConnectionDto"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConnectionRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"connections"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "ConnectionController_getAllConnections",
|
|
"parameters": [
|
|
{
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/connections/{id}": {
|
|
"put": {
|
|
"operationId": "ConnectionController_updateConnection",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateConnectionDto"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConnectionRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"connections"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "ConnectionController_deleteConnection",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConnectionRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"connections"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "ConnectionController_getConnectionDetails",
|
|
"parameters": [
|
|
{
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/network-config": {
|
|
"get": {
|
|
"operationId": "NetworkConfigController_findAllNetworkConfigs",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Network Config"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "NetworkConfigController_createNetworkConfigs",
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateNetworkConfigReq"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateNetworkConfigRes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateNetworkConfigRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Network Config"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/network-config/{id}": {
|
|
"get": {
|
|
"operationId": "NetworkConfigController_findNetworkConfigById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Network Config"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/network-config/{id}/details": {
|
|
"get": {
|
|
"operationId": "NetworkConfigController_findNetworkConfigByIdDetails",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/FindAllNetworkConfigsRes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Network Config"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/inputs": {
|
|
"post": {
|
|
"operationId": "InputsController_create",
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateInputReq"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Input"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"Inputs"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/inputs/{id}": {
|
|
"get": {
|
|
"operationId": "InputsController_findOne",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2": {
|
|
"post": {
|
|
"operationId": "PipelinesController_create",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ICreatePipelineV2Req"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/IPipelineV2"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"operationId": "PipelinesController_findAll",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2/download-logs": {
|
|
"get": {
|
|
"operationId": "PipelinesController_downloadLogs",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "pipeline_run_id",
|
|
"required": true,
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2/{id}/config": {
|
|
"get": {
|
|
"operationId": "PipelinesController_getPipelineproperties",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2/{id}/objects": {
|
|
"get": {
|
|
"operationId": "PipelinesController_getPipelineObjects",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2/{id}/status": {
|
|
"get": {
|
|
"operationId": "PipelinesController_getPipelineStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pipelinesV2/{id}": {
|
|
"get": {
|
|
"operationId": "PipelinesController_findOne",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"patch": {
|
|
"operationId": "PipelinesController_update",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "PipelinesController_delete",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"PipelinesV2"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/catalog": {
|
|
"get": {
|
|
"operationId": "CatalogController_searchCatalog",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "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"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ICatalogAllResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "CatalogController_createDataAsset",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ICreateDataAsset"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/catalog/data-asset/{id}": {
|
|
"get": {
|
|
"operationId": "CatalogController_getDataAsset",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "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": []
|
|
}
|
|
]
|
|
},
|
|
"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": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "CatalogController_deleteDataAsset",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/catalog/data-asset/{id}/columns-metadata": {
|
|
"get": {
|
|
"operationId": "CatalogController_getDataAssetColumnsMetadata",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/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"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/IDocsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"operationId": "CatalogController_manageDataAssetDocs",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/catalog/data-asset/{id}/comment": {
|
|
"post": {
|
|
"operationId": "CatalogController_commentOnDataAsset",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/IMakeAComment"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"operationId": "CatalogController_deleteComment",
|
|
"parameters": [
|
|
{
|
|
"name": "dadosfera-lang",
|
|
"in": "header",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"pt-br",
|
|
"en-us"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"required": true,
|
|
"in": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/IDeleteComment"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Catalog"
|
|
],
|
|
"security": [
|
|
{
|
|
"access-token": []
|
|
},
|
|
{
|
|
"access-token": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/oauth/hubspot": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthHubspot",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/oauth/googleads": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthGoogleAds",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/oauth/google-sheets": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthGoogleSheets",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/oauth/facebook": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthFacebook",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/oauth/mailchimp": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthMailchimp",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/oauth/salesforce": {
|
|
"get": {
|
|
"operationId": "OauthController_oauthSalesforce",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"oauth"
|
|
]
|
|
}
|
|
},
|
|
"/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": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/health": {
|
|
"get": {
|
|
"operationId": "HealthController_check",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
},
|
|
"tags": [
|
|
"Health"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"info": {
|
|
"title": "Maestro - feat/new-customer-monitoring",
|
|
"description": "This is the Maestro API",
|
|
"version": "1.0.0",
|
|
"contact": {}
|
|
},
|
|
"tags": [],
|
|
"servers": [
|
|
{
|
|
"url": "https://maestro.dadosfera.ai",
|
|
"description": "Dadosfera API"
|
|
}
|
|
],
|
|
"components": {
|
|
"securitySchemes": {
|
|
"access-token": {
|
|
"type": "apiKey",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
},
|
|
"schemas": {
|
|
"AuthSignInReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"totp": {
|
|
"type": "string",
|
|
"description": "TOTP code used to login when Multi-Factor Authentication is enabled"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password"
|
|
]
|
|
},
|
|
"AuthCustomer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"modules": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"tier": {
|
|
"type": "string"
|
|
},
|
|
"scheduleLimit": {
|
|
"type": "string"
|
|
},
|
|
"links": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"modules",
|
|
"id",
|
|
"name",
|
|
"tier",
|
|
"scheduleLimit",
|
|
"links"
|
|
]
|
|
},
|
|
"AuthUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"username",
|
|
"createdAt"
|
|
]
|
|
},
|
|
"AuthTokens": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accessToken": {
|
|
"type": "string"
|
|
},
|
|
"refreshToken": {
|
|
"type": "string"
|
|
},
|
|
"termsOfUseToken": {
|
|
"type": "string"
|
|
},
|
|
"idToken": {
|
|
"type": "string",
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"required": [
|
|
"accessToken",
|
|
"refreshToken",
|
|
"idToken"
|
|
]
|
|
},
|
|
"TermsOfUse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"publicUrl": {
|
|
"type": "string"
|
|
},
|
|
"enforceDate": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"publicUrl",
|
|
"enforceDate",
|
|
"createdAt"
|
|
]
|
|
},
|
|
"TermsOfUseStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"pending",
|
|
"required",
|
|
"ok"
|
|
]
|
|
},
|
|
"lastSigned": {
|
|
"$ref": "#/components/schemas/TermsOfUse"
|
|
},
|
|
"next": {
|
|
"$ref": "#/components/schemas/TermsOfUse"
|
|
}
|
|
},
|
|
"required": [
|
|
"status"
|
|
]
|
|
},
|
|
"AuthSignInRes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"mfaStatus": {
|
|
"type": "string",
|
|
"enum": [
|
|
"pending",
|
|
"none",
|
|
"totp"
|
|
]
|
|
},
|
|
"customer": {
|
|
"$ref": "#/components/schemas/AuthCustomer"
|
|
},
|
|
"user": {
|
|
"$ref": "#/components/schemas/AuthUser"
|
|
},
|
|
"tokens": {
|
|
"$ref": "#/components/schemas/AuthTokens"
|
|
},
|
|
"termsOfUse": {
|
|
"$ref": "#/components/schemas/TermsOfUseStatus"
|
|
}
|
|
},
|
|
"required": [
|
|
"permissions",
|
|
"mfaStatus"
|
|
]
|
|
},
|
|
"AuthRefreshAccessTokenReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshToken": {
|
|
"type": "string"
|
|
},
|
|
"customerName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"refreshToken",
|
|
"customerName"
|
|
]
|
|
},
|
|
"AuthRefreshAccessTokenRes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"accessToken": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"permissions",
|
|
"accessToken"
|
|
]
|
|
},
|
|
"CreateConnectionDto": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"network_config_id": {
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"type": "object"
|
|
},
|
|
"connector_id": {
|
|
"type": "string"
|
|
},
|
|
"connector_name": {
|
|
"type": "string"
|
|
},
|
|
"plugin": {
|
|
"type": "string"
|
|
},
|
|
"image_url": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"description",
|
|
"type",
|
|
"properties",
|
|
"connector_id",
|
|
"connector_name",
|
|
"plugin",
|
|
"image_url"
|
|
]
|
|
},
|
|
"ConnectionToCatalogDto": {
|
|
"type": "object",
|
|
"properties": {
|
|
"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"
|
|
]
|
|
},
|
|
"NetworkConfigToCatalogDto": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"type": "string"
|
|
},
|
|
"plugin": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
},
|
|
"network_type_id": {
|
|
"type": "string"
|
|
},
|
|
"network_type_name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"customer_id",
|
|
"plugin",
|
|
"type",
|
|
"name",
|
|
"description",
|
|
"created_at",
|
|
"updated_at",
|
|
"network_type_id",
|
|
"network_type_name"
|
|
]
|
|
},
|
|
"FindAllNetworkConfigsRes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"network_configs": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NetworkConfigToCatalogDto"
|
|
}
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"network_configs",
|
|
"message"
|
|
]
|
|
},
|
|
"CreateNetworkConfigReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"network_type_id": {
|
|
"type": "string"
|
|
},
|
|
"network_type_name": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"ovpn_file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
},
|
|
"required": [
|
|
"network_type_id",
|
|
"network_type_name",
|
|
"name",
|
|
"description",
|
|
"ovpn_file"
|
|
]
|
|
},
|
|
"CreateNetworkConfigRes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"network_config": {
|
|
"$ref": "#/components/schemas/NetworkConfigToCatalogDto"
|
|
}
|
|
},
|
|
"required": [
|
|
"network_config"
|
|
]
|
|
},
|
|
"TableColumns": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"columns": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"references": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"columns",
|
|
"references",
|
|
"type"
|
|
]
|
|
},
|
|
"CreateInputReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tables": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TableColumns"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"plugin": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tables",
|
|
"name",
|
|
"description",
|
|
"plugin"
|
|
]
|
|
},
|
|
"Input": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"tables": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TableColumns"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"plugin": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"tables",
|
|
"name",
|
|
"description",
|
|
"plugin",
|
|
"created_at",
|
|
"updated_at"
|
|
]
|
|
},
|
|
"ICreatePipelineV2Req": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"IRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"id"
|
|
]
|
|
},
|
|
"IUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"id"
|
|
]
|
|
},
|
|
"IComment": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "number"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"message",
|
|
"created_at",
|
|
"username"
|
|
]
|
|
},
|
|
"EmbedObject": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"url"
|
|
]
|
|
},
|
|
"IDataAsset": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "number"
|
|
},
|
|
"database_name": {
|
|
"type": "string"
|
|
},
|
|
"table_name": {
|
|
"type": "string"
|
|
},
|
|
"num_columns": {
|
|
"type": "number"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"created_time": {
|
|
"type": "string"
|
|
},
|
|
"table_type": {
|
|
"type": "string"
|
|
},
|
|
"size_in_bytes": {
|
|
"type": "number"
|
|
},
|
|
"num_files": {
|
|
"type": "number"
|
|
},
|
|
"data_encrypted": {
|
|
"type": "string"
|
|
},
|
|
"num_rows": {
|
|
"type": "number"
|
|
},
|
|
"display_name": {
|
|
"type": "string"
|
|
},
|
|
"pipeline_id": {
|
|
"type": "string"
|
|
},
|
|
"user_id": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"data_asset_type": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"owner": {
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IRole"
|
|
}
|
|
},
|
|
"users": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IUser"
|
|
}
|
|
},
|
|
"dashboard_id": {
|
|
"type": "number"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"embedding_params": {
|
|
"type": "object"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
},
|
|
"comments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IComment"
|
|
}
|
|
},
|
|
"embed": {
|
|
"$ref": "#/components/schemas/EmbedObject"
|
|
},
|
|
"share_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"public",
|
|
"private"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"display_name",
|
|
"pipeline_id",
|
|
"user_id",
|
|
"description",
|
|
"data_asset_type",
|
|
"tags",
|
|
"owner",
|
|
"roles",
|
|
"users",
|
|
"created_at",
|
|
"comments"
|
|
]
|
|
},
|
|
"ICatalogAllResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data_assets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IDataAsset"
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"data_assets",
|
|
"total"
|
|
]
|
|
},
|
|
"IColumnMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"table_name": {
|
|
"type": "string"
|
|
},
|
|
"column_name": {
|
|
"type": "string"
|
|
},
|
|
"data_type": {
|
|
"type": "string"
|
|
},
|
|
"missing_count": {
|
|
"type": "string"
|
|
},
|
|
"min": {
|
|
"type": "string"
|
|
},
|
|
"max": {
|
|
"type": "string"
|
|
},
|
|
"count": {
|
|
"type": "string"
|
|
},
|
|
"histogram": {
|
|
"type": "string"
|
|
},
|
|
"mean": {
|
|
"type": "string"
|
|
},
|
|
"median": {
|
|
"type": "string"
|
|
},
|
|
"missing_rate": {
|
|
"type": "string"
|
|
},
|
|
"stddev": {
|
|
"type": "string"
|
|
},
|
|
"unique_count": {
|
|
"type": "string"
|
|
},
|
|
"unique_rate": {
|
|
"type": "string"
|
|
},
|
|
"analyzer_rules": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"table_name",
|
|
"column_name",
|
|
"data_type",
|
|
"missing_count",
|
|
"min",
|
|
"max",
|
|
"count",
|
|
"histogram",
|
|
"mean",
|
|
"median",
|
|
"missing_rate",
|
|
"stddev",
|
|
"unique_count",
|
|
"unique_rate",
|
|
"analyzer_rules",
|
|
"version"
|
|
]
|
|
},
|
|
"IColumnsMetadataResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columns_metadata": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IColumnMetadata"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columns_metadata"
|
|
]
|
|
},
|
|
"IData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"var": {
|
|
"type": "number"
|
|
},
|
|
"date": {
|
|
"type": "string"
|
|
},
|
|
"last": {
|
|
"type": "number"
|
|
},
|
|
"maximum": {
|
|
"type": "number"
|
|
},
|
|
"minimum": {
|
|
"type": "number"
|
|
},
|
|
"day_opening": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"var",
|
|
"date",
|
|
"last",
|
|
"maximum",
|
|
"minimum",
|
|
"day_opening"
|
|
]
|
|
},
|
|
"IPreview": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"database_name": {
|
|
"type": "string"
|
|
},
|
|
"table_name": {
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/IData"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"database_name",
|
|
"table_name",
|
|
"data"
|
|
]
|
|
},
|
|
"IPreviewResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"preview": {
|
|
"$ref": "#/components/schemas/IPreview"
|
|
}
|
|
},
|
|
"required": [
|
|
"preview"
|
|
]
|
|
},
|
|
"IDocs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"docs": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
},
|
|
"table_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"docs",
|
|
"updated_at",
|
|
"table_id"
|
|
]
|
|
},
|
|
"IDocsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"docs": {
|
|
"$ref": "#/components/schemas/IDocs"
|
|
}
|
|
},
|
|
"required": [
|
|
"docs"
|
|
]
|
|
},
|
|
"IUpdateDataRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"embed": {
|
|
"$ref": "#/components/schemas/EmbedObject"
|
|
},
|
|
"share_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"public",
|
|
"private"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"description",
|
|
"tags"
|
|
]
|
|
},
|
|
"IOneDataAsset": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data_asset": {
|
|
"$ref": "#/components/schemas/IDataAsset"
|
|
}
|
|
},
|
|
"required": [
|
|
"data_asset"
|
|
]
|
|
},
|
|
"ICreateDataAsset": {
|
|
"type": "object",
|
|
"properties": {
|
|
"display_name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"data_asset_type": {
|
|
"type": "string"
|
|
},
|
|
"external_url": {
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"embed": {
|
|
"$ref": "#/components/schemas/EmbedObject"
|
|
}
|
|
},
|
|
"required": [
|
|
"display_name",
|
|
"description",
|
|
"data_asset_type",
|
|
"external_url",
|
|
"location"
|
|
]
|
|
},
|
|
"IMakeAComment": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"CommentToDelete": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "number"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
]
|
|
},
|
|
"IDeleteComment": {
|
|
"type": "object",
|
|
"properties": {
|
|
"comment": {
|
|
"$ref": "#/components/schemas/CommentToDelete"
|
|
}
|
|
},
|
|
"required": [
|
|
"comment"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"CustomerLink": {
|
|
"type": "object",
|
|
"properties": {
|
|
"href": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"iconSrc": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"href",
|
|
"name",
|
|
"description"
|
|
]
|
|
},
|
|
"CustomerLinksResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"links": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/CustomerLink"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"links"
|
|
]
|
|
},
|
|
"CustomerLinkRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"links": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/CustomerLink"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"links"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |