Merge pull request #496 from dadosfera/feat/documentation-status

FIX: pin npm version to 10.8.2 in Dockerfile for consistency

Dockerfile

@@ -1,5 +1,5 @@
 FROM node:20-alpine AS base_image
-RUN npm install -g npm@latest
+RUN npm install -g npm@10.8.2
 
 FROM base_image AS build_base
 WORKDIR /app

docsfera.json

@@ -4574,6 +4574,7 @@
         "get": {
           "operationId": "PlatformApiController_getPipelineRunJobs",
           "summary": "Get pipeline run jobs",
+          "description": "Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.",
           "parameters": [
             {
               "name": "pipelineId",
@@ -4594,11 +4595,22 @@
           ],
           "responses": {
             "200": {
-              "description": "",
+              "description": "DB-backed job runs for the selected pipeline run.",
               "content": {
                 "application/json": {
                   "schema": {
-                    "type": "object"
+                    "type": "object",
+                    "properties": {
+                      "jobs": {
+                        "type": "array",
+                        "items": {
+                          "type": "object"
+                        }
+                      }
+                    },
+                    "required": [
+                      "jobs"
+                    ]
                   }
                 }
               }
@@ -11001,6 +11013,15 @@
             },
             "docs": {
               "type": "string"
+            },
+            "certification_status": {
+              "type": "string",
+              "enum": [
+                "draft",
+                "in_review",
+                "approved",
+                "deprecated"
+              ]
             }
           },
           "required": [

package-lock.json

@@ -16,7 +16,7 @@
         "@aws-sdk/lib-dynamodb": "^3.414.0",
         "@aws-sdk/signature-v4": "^3.370.0",
         "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-        "@dadosfera/protospack-v2": "3.40.0-beta.10",
+        "@dadosfera/protospack-v2": "^3.40.0-beta.10",
         "@grpc/grpc-js": "^1.9.3",
         "@grpc/proto-loader": "^0.7.9",
         "@nestjs/cli": "^9.5.0",
@@ -1738,7 +1738,6 @@
       "version": "3.40.0-beta.10",
       "resolved": "https://dadosfera-611330257153.d.codeartifact.us-east-1.amazonaws.com/npm/dadosfera-npm/@dadosfera/protospack-v2/-/protospack-v2-3.40.0-beta.10.tgz",
       "integrity": "sha512-F45dSEIKG+gwwDMYHayA242bFwhFTJbZm26KesQbGhf4I45ur6hYZD8dK0voNuVQInLMQhtm6+7th6/jJ8xpTQ==",
-      "license": "ISC",
       "dependencies": {
         "@grpc/grpc-js": "^1.9.3",
         "rxjs": "^7.5.5"

package.json

@@ -34,7 +34,7 @@
     "@aws-sdk/lib-dynamodb": "^3.414.0",
     "@aws-sdk/signature-v4": "^3.370.0",
     "@dadosfera/dadosfera-logs": "^1.0.0-beta.4",
-    "@dadosfera/protospack-v2": "3.40.0-beta.10",
+    "@dadosfera/protospack-v2": "^3.40.0-beta.10",
     "@grpc/grpc-js": "^1.9.3",
     "@grpc/proto-loader": "^0.7.9",
     "@nestjs/cli": "^9.5.0",

src/modules/catalog/dtos/index.ts

@@ -6,6 +6,12 @@ export enum DataAssetShareType {
   public = 'public',
   private = 'private',
 }
+export enum CertificationStatus {
+  draft = 'draft',
+  in_review = 'in_review',
+  approved = 'approved',
+  deprecated = 'deprecated',
+}
 export enum OrderEnum {
   asc = 'asc',
   desc = 'desc',
@@ -204,6 +210,8 @@ export class IUpdateDataRequest {
   share_type?: DataAssetShareType;
   @ApiPropertyOptional()
   docs?: string;
+  @ApiPropertyOptional({ enum: CertificationStatus })
+  certification_status?: CertificationStatus;
 }
 export class ICreateDataAsset implements CreateDataAssetRequest {
   @ApiProperty()

src/modules/pipelinesV2/pipelines.controller.ts

@@ -15,6 +15,7 @@ import {
   HttpException,
   BadRequestException,
   UseGuards,
+  Res,
 } from '@nestjs/common';
 import {
   ApiCreatedResponse,

src/modules/platform-api/platform-api.controller.ts

@@ -14,7 +14,7 @@ import {
   NotFoundException,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags, ApiOperation } from '@nestjs/swagger';
+import { ApiTags, ApiOperation, ApiOkResponse } from '@nestjs/swagger';
 import { DadosferaLogger } from '@dadosfera/dadosfera-logs';
 
 import {
@@ -72,6 +72,10 @@ export class PlatformApiController {
     return id?.replace(/-/g, '_') || '';
   }
 
+  private decodePathParam(value: string): string {
+    return value ? decodeURIComponent(value) : '';
+  }
+
   /**
    * Denormalize ID back to UUID format (replace _ with -).
    * Used when we receive a normalized ID but need the original UUID.
@@ -833,7 +837,23 @@ export class PlatformApiController {
   }
 
   @Get('pipelines/:pipelineId/pipeline_run/:runId/jobs')
-  @ApiOperation({ summary: 'Get pipeline run jobs' })
+  @ApiOperation({
+    summary: 'Get pipeline run jobs',
+    description: 'Proxies platform-api DB-backed job runs and returns `{ jobs: [...] }`.',
+  })
+  @ApiOkResponse({
+    description: 'DB-backed job runs for the selected pipeline run.',
+    schema: {
+      type: 'object',
+      properties: {
+        jobs: {
+          type: 'array',
+          items: { type: 'object' },
+        },
+      },
+      required: ['jobs'],
+    },
+  })
   @RequireAllPermissions(PERMISSIONS_GROUPS.PIPELINE.permissions.GET)
   async getPipelineRunJobs(
     @Param('pipelineId') pipelineId: string,
@@ -841,11 +861,11 @@ export class PlatformApiController {
     @User() user: RequestUser,
   ) {
     const normalizedPipelineId = this.normalizePipelineId(pipelineId);
-    const normalizedRunId = this.normalizePipelineId(runId);
+    const decodedRunId = this.decodePathParam(runId);
 
     return this.platformApiService.proxy(
       'GET',
-      `/pipeline/${normalizedPipelineId}/pipeline_run/${normalizedRunId}/jobs`,
+      `/pipeline/${normalizedPipelineId}/pipeline_run/${decodedRunId}/jobs`,
       user,
     );
   }