FEAT: add endpoint to update column description in catalog

This commit is contained in:
viniciusgadea
2026-08-20 08:26:56 -03:00
parent 7051b21d86
commit 6efc25ad5e
3 changed files with 99 additions and 0 deletions
+43
View File
@@ -5924,6 +5924,49 @@
]
}
},
"/catalog/data-asset/{id}/columns-metadata/description": {
"patch": {
"operationId": "CatalogController_updateColumnDescription",
"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}/preview": {
"get": {
"operationId": "CatalogController_getDataAssetPreview",
+37
View File
@@ -9,6 +9,7 @@ import {
Inject,
NotFoundException,
Param,
Patch,
Post,
Put,
Query,
@@ -431,6 +432,42 @@ export class CatalogController {
return { columns_metadata };
}
@Patch('data-asset/:id/columns-metadata/description')
@RequireSomePermission(
PERMISSIONS_GROUPS.CATALOG.permissions.UPDATE,
PERMISSIONS_GROUPS.CATALOG.permissions.DATA_MANAGER,
)
async updateColumnDescription(
@User() user: RequestUser,
@Language() language: LanguageEnum,
@Param('id') id: string,
@Body() body: { column_name: string; description: string },
): Promise<{ success: boolean }> {
const { customer_name, customer_id, user_id, username } = user;
this.logger.info(`/catalog - update column description`, {
user_id,
customer_name,
});
const metadata = PackTheMetadata({
customer_name,
customer_id,
user_id,
username,
language,
});
await this.catalogService.updateColumnDescription(
id,
body.column_name,
body.description,
metadata,
);
return { success: true };
}
@Get('data-asset/:id/preview')
@RequireSomePermission(
PERMISSIONS_GROUPS.CATALOG.permissions.GET,
+19
View File
@@ -463,6 +463,25 @@ class CatalogService implements OnModuleInit {
return result;
}
async updateColumnDescription(
id: string,
column_name: string,
description: string,
metadata: Metadata,
) {
await lastValueFrom(
this.catalogWriteService.UpdateDataAsset(
{
id,
changes: JSON.stringify({
column_description: { column_name, description },
}),
},
metadata,
),
);
}
async createDataDocs(body: CreateDataDocsDTO, metadata: Metadata) {
if (body.asset_type === 'table' || body.asset_type === 'view') {
return this.createDataDocsViaNimbus(body);