fix: resolved ApiParam inconsistencies and corrected TypeScript-Angular generator name in openapi-generator (#1426)

Author: Junjiequan

.github/openapi/typescript-config.json renamed to .github/openapi/typescript-angular-config.json

@@ -131,7 +131,7 @@ jobs:
       - start-backend-export-swagger
     strategy:
       matrix:
-        generator: [python, python-pydantic-v1, typescript]
+        generator: [python, python-pydantic-v1, typescript-angular]
 
     steps:
       - name: Checkout repository
@@ -152,7 +152,7 @@ jobs:
             --git-repo-id scicat-backend-next \
             --git-user-id SciCatProject \
             -o ./sdk/${{ matrix.generator }} $(
-            if [ "${{ matrix.generator }}" == "typescript" ]; then
+            if [ "${{ matrix.generator }}" == "typescript-angular" ]; then
               echo "--additional-properties=npmVersion=${{ needs.build-release.outputs.new_tag}}";
             elif [ "${{ matrix.generator }}" == "python" ]; then
               echo "--additional-properties=packageVersion=${{ needs.build-release.outputs.new_tag}}";
@@ -183,18 +183,18 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
           registry-url: "https://registry.npmjs.org/"
 
-      - name: Download TypeScript SDK Artifact
+      - name: Download TypeScript Angular SDK Artifact
         uses: actions/download-artifact@v4
         with:
-          name: sdk-typescript-${{github.sha}}
+          name: sdk-typescript-angular-${{github.sha}}
           path: ./sdk
 
       - name: Publish package
         run: |
           npm install
           npm run build
           npm publish --access public
-        working-directory: ./sdk/typescript/
+        working-directory: ./sdk/typescript-angular/
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 

.github/workflows/release-and-publish-sdk.yml

@@ -48,7 +48,7 @@ jobs:
       - start-backend-and-upload-swagger-schema
     strategy:
       matrix:
-        generator: [python, typescript, python-pydantic-v1]
+        generator: [python, typescript-angular, python-pydantic-v1]
 
     steps:
       - name: Checkout repository
@@ -67,7 +67,7 @@ jobs:
           config-file: .github/openapi/${{ matrix.generator }}-config.json
           command-args: |
             -o ./sdk/${{ matrix.generator }} $(
-            if [ "${{ matrix.generator }}" == "typescript" ]; then
+            if [ "${{ matrix.generator }}" == "typescript-angular" ]; then
               echo "--additional-properties=npmVersion=${{env.SDK_VERSION}}";
             elif [ "${{ matrix.generator }}" == "python" ]; then
               echo "--additional-properties=packageVersion=${{env.SDK_VERSION}}";

.github/workflows/upload-sdk-artifact.yml

@@ -566,7 +566,7 @@ export class SamplesController {
       "Returns a boolean indicating whether the user has access to the sample with the specified ID.",
   })
   @ApiParam({
-    name: "pid",
+    name: "id",
     description: "ID of the sample to check access for",
     type: String,
   })
@@ -774,17 +774,17 @@ export class SamplesController {
   })
   async findOneAttachment(
     @Req() request: Request,
-    @Param("id") sampleId: string,
+    @Param("id") id: string,
     @Param("fk") attachmentId: string,
   ): Promise<Attachment | null> {
     await this.checkPermissionsForSample(
       request,
-      sampleId,
+      id,
       Action.SampleAttachmentRead,
     );
     return this.attachmentsService.findOne({
       id: attachmentId,
-      sampleId: sampleId,
+      sampleId: id,
     });
   }
 
@@ -816,17 +816,17 @@ export class SamplesController {
   })
   async findOneAttachmentAndRemove(
     @Req() request: Request,
-    @Param("id") sampleId: string,
+    @Param("id") id: string,
     @Param("fk") attachmentId: string,
   ): Promise<unknown> {
     await this.checkPermissionsForSample(
       request,
-      sampleId,
+      id,
       Action.SampleAttachmentDelete,
     );
     return this.attachmentsService.findOneAndDelete({
       _id: attachmentId,
-      sampleId: sampleId,
+      sampleId: id,
     });
   }
 
@@ -867,7 +867,7 @@ export class SamplesController {
   })
   async findAllDatasets(
     @Req() request: Request,
-    @Param("id") sampleId: string,
+    @Param("id") id: string,
   ): Promise<DatasetClass[] | null> {
     const user: JWTUser = request.user as JWTUser;
     const ability = this.caslAbilityFactory.samplesInstanceAccess(user);
@@ -900,7 +900,7 @@ export class SamplesController {
     }
 
     const dataset = await this.datasetsService.fullquery({
-      where: { sampleId },
+      where: { sampleId: id },
       fields: fields,
     });
     return dataset;