fix: add examples (#1282)

Signed-off-by: Krishna Waske <[email protected]>

Author: GHkrishna

apps/api-gateway/src/agent-service/agent-service.controller.ts

@@ -22,7 +22,6 @@ import {
   ApiOperation,
   ApiForbiddenResponse,
   ApiBody,
-  ApiParam,
   ApiBearerAuth,
   ApiUnauthorizedResponse
 } from '@nestjs/swagger';
@@ -32,7 +31,7 @@ import { ForbiddenErrorDto } from '../dtos/forbidden-error.dto';
 import { ResponseMessages } from '@credebl/common/response-messages';
 import { AgentService } from './agent-service.service';
 import IResponseType, { IResponse } from '@credebl/common/interfaces/response.interface';
-import { AgentSpinupDto, SignDataDto } from './dto/agent-service.dto';
+import { AgentSpinupDto, SignDataDto, VerifySignatureDto } from './dto/agent-service.dto';
 import { Response } from 'express';
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { user } from '@prisma/client';
@@ -48,6 +47,7 @@ import { CreateNewDidDto } from './dto/create-new-did.dto';
 import { AgentSpinupValidator, TrimStringParamPipe } from '@credebl/common/cast.helper';
 import { AgentConfigureDto } from './dto/agent-configure.dto';
 import { UnauthorizedErrorDto } from '../dtos/unauthorized-error.dto';
+import { IVerifySignature } from './interface/agent-service.interface';
 
 const seedLength = 32;
 
@@ -143,14 +143,8 @@ export class AgentController {
    */
   @ApiBody({
     description:
-      'Enter the data you would like to verify the signature for. It can be of type w3c jsonld credential or any type that needs to be verified'
-  })
-  @ApiParam({
-    name: 'dataType',
-    type: String,
-    required: false,
-    description:
-      'dataType of the data you are sverifying the signature. It can be a credential or a random object of any data type. For credentials, currently only w3c-jsonld credentials are supported to be verified'
+      'Enter the data you would like to verify the signature for. It can be of type w3c jsonld credential or any type that needs to be verified',
+    type: VerifySignatureDto
   })
   @Post('/orgs/:orgId/agents/verify-signature')
   @ApiOperation({
@@ -169,8 +163,7 @@ export class AgentController {
   )
   async verifysignature(
     @Param('orgId') orgId: string,
-    @Body() data: unknown,
-    @Param('dataType') dataType: string,
+    @Body() data: IVerifySignature,
     @Res() res: Response
   ): Promise<Response> {
     const agentData = await this.agentService.verifysignature(data, orgId);

apps/api-gateway/src/agent-service/dto/agent-service.dto.ts

@@ -213,3 +213,87 @@ export class SignDataDto {
   @Type(() => SignRawDataDto)
   rawPayload?: SignRawDataDto;
 }
+
+export class VerifySignatureDto {
+  @ApiProperty({
+    description: 'This is the signed w3c-jsonLd credential, which we want to verify',
+    example: {
+      id: 'http://example.com/credential/9290ae08-8959-4723-a26a-921aab97de6e',
+      name: 'Teamwork v2',
+      type: ['VerifiableCredential', 'OpenBadgeCredential'],
+      image: {
+        id: 'https://example.com/BadgeDesigns/a99a4121-e04e-477c-a890-15e9af789f73/1c61a4b2-dca4-4684-8f63-221333fd5c86-Teamwork%20v2.png',
+        type: 'Image'
+      },
+      proof: {
+        jws: 'eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..PN0gqrfiMhO_2AIT9i3Tv1Qt9Owlh5ZBPnplCrta49-6oyEpHg4aQwjGADe-B2RADb_cvdgVqTJe1G-ds9UYDg',
+        type: 'Ed25519Signature2018',
+        created: '2025-06-13T13:47:35Z',
+        proofPurpose: 'assertionMethod',
+        verificationMethod:
+          'did:key:z6MkwSMgqptU9M5AiymSSXv3HLhEhXfE6RonJwMSG2dmURdE#z6MkwSMgqptU9M5AiymSSXv3HLhEhXfE6RonJwMSG2dmURdE'
+      },
+      issuer: {
+        id: 'did:key:z6MkwSMgqptU9M5AiymSSXv3HLhEhXfE6RonJwMSG2dmURdE'
+      },
+      '@context': [
+        'https://www.w3.org/2018/credentials/v1',
+        'https://w3id.org/security/data-integrity/v2',
+        'https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json'
+      ],
+      validFrom: '2025-06-13T13:47:35.201Z',
+      awardedDate: '2025-06-12T18:30:00.000Z',
+      description:
+        'EricTech is a cutting-edge product innovation company specialising in Web 3.0 development with extensive expertise in modern technologies. Our unique approach to product invention involves a comprehensive process, starting from the discovery phase and progressing through planning, research, development, marketing, and launch, all tailored to assist businesses in achieving their goals.',
+      issuanceDate: '2025-06-13T13:47:35.201Z',
+      expirationDate: '2026-12-30T18:30:00.000Z',
+      credentialStatus: {
+        id: 'http://example.com/revocation/addfc5a0-258f-4977-a138-f0d9f33d6dc6',
+        type: '1EdTechRevocationList'
+      },
+      credentialSubject: {
+        type: ['AchievementSubject'],
+        identifier: [
+          {
+            type: 'IdentityObject',
+            hashed: 'FALSE',
+            identityHash: '[email protected]',
+            identityType: 'emailAddress'
+          }
+        ],
+        achievement: {
+          id: 'ds',
+          Tag: ['fghfgh', 'fhfgh'],
+          Type: ['Achievement'],
+          name: 'sddgh',
+          image: {
+            id: 'sdsd',
+            type: 'sdd'
+          },
+          version: '2',
+          criteria: {
+            narrative: 'sdd'
+          },
+          humanCode: 'sd',
+          description: 'sdd',
+          fieldOfStudy: 'sdsd',
+          specialization: 'fghfg',
+          achievementType: 'LearningProgram',
+          otherIdentifier: [
+            {
+              type: 'fhgf',
+              identifier: 'fghfgh',
+              identifierType: 'fghfgh'
+            }
+          ]
+        }
+      }
+    }
+  })
+  credential: unknown;
+
+  @ApiPropertyOptional({ default: false })
+  @IsOptional()
+  @IsBoolean()
+  verifyCredentialStatus?: boolean;
+}

apps/api-gateway/src/agent-service/interface/agent-service.interface.ts

@@ -1,26 +1,31 @@
 export interface AgentSpinUpSatus {
-    agentSpinupStatus: number;
+  agentSpinupStatus: number;
 }
 export interface AgentStatus {
-    label: string;
-    endpoints: string[];
-    isInitialized: boolean;
+  label: string;
+  endpoints: string[];
+  isInitialized: boolean;
 }
 interface IWalletConfig {
-    id: string;
-    key: string;
-    keyDerivationMethod: string;
+  id: string;
+  key: string;
+  keyDerivationMethod: string;
 }
 
 interface IConfig {
-    label: string;
-    walletConfig: IWalletConfig;
+  label: string;
+  walletConfig: IWalletConfig;
 }
 export interface IWalletRecord {
-    _tags: string;
-    metadata: string;
-    id: string;
-    createdAt: string;
-    config: IConfig;
-    updatedAt: string;
-}
+  _tags: string;
+  metadata: string;
+  id: string;
+  createdAt: string;
+  config: IConfig;
+  updatedAt: string;
+}
+
+export interface IVerifySignature {
+  credential: unknown;
+  verifyCredentialStatus?: boolean;
+}