docs: ✏️ Update swagger examples to display asset IDs

PolymeshAssociation · Nov 26, 2024 · 89f96d0 · 89f96d0
1 parent 5ccb402
commit 89f96d0
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/src/accounts/models/asset-permissions.model.ts b/src/accounts/models/asset-permissions.model.ts
@@ -9,7 +9,7 @@ export class AssetPermissionsModel extends PermissionTypeModel {
     description: 'List of included/excluded Assets',
     type: 'string',
     isArray: true,
-    example: ['TICKER123456'],
+    example: ['3616b82e-8e10-80ae-dc95-2ea28b9db8b3'],
   })
   readonly values: string[];
 

diff --git a/src/claims/decorators/validation.ts b/src/claims/decorators/validation.ts
@@ -75,7 +75,7 @@ export function IsValidScopeValue(property: string, validationOptions?: Validati
           const scopeType = (args.object as any)[scopeTypeField];
           switch (scopeType) {
             case ScopeType.Asset:
-              return 'value must be a valid Asset ID either in hex or UUID format';
+              return 'value must be a valid Asset ID (either in hex or UUID format) or a valid ticker (all uppercase and no longer than 12 characters)';
             case ScopeType.Ticker:
               return `value must be all uppercase and no longer than 12 characters for type: ${scopeType}`;
             case ScopeType.Identity:

diff --git a/src/compliance/dto/set-requirements.dto.ts b/src/compliance/dto/set-requirements.dto.ts
@@ -30,8 +30,8 @@ export class SetRequirementsDto extends TransactionBaseDto {
             {
               type: 'Jurisdiction',
               scope: {
-                type: 'Ticker',
-                value: 'TICKER',
+                type: 'Asset',
+                value: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
               },
               code: CountryCode.Us,
             },
@@ -51,8 +51,8 @@ export class SetRequirementsDto extends TransactionBaseDto {
           claim: {
             type: 'Accredited',
             scope: {
-              type: 'Ticker',
-              value: 'TICKER',
+              type: 'Asset',
+              value: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
             },
           },
         },

diff --git a/src/identities/dto/asset-permissions.dto.ts b/src/identities/dto/asset-permissions.dto.ts
@@ -12,7 +12,7 @@ export class AssetPermissionsDto extends PermissionTypeDto {
     description: 'List of assets to be included or excluded in the permissions',
     type: 'string',
     isArray: true,
-    example: ['TICKER123456'],
+    example: ['3616b82e-8e10-80ae-dc95-2ea28b9db8b3'],
   })
   @IsArray()
   @IsAsset({ each: true })

diff --git a/src/portfolios/dto/portfolio-movement.dto.ts b/src/portfolios/dto/portfolio-movement.dto.ts
@@ -10,7 +10,7 @@ import { IsAsset, IsBigNumber } from '~/common/decorators/validation';
 export class PortfolioMovementDto {
   @ApiProperty({
     description: 'Asset to move',
-    example: 'TICKER',
+    example: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
   })
   @IsAsset()
   readonly asset: string;

diff --git a/src/settlements/dto/leg-validation-params.dto.ts b/src/settlements/dto/leg-validation-params.dto.ts
@@ -68,7 +68,7 @@ export class LegValidationParamsDto {
   @ApiProperty({
     description: 'The Asset (Asset ID/Ticker) to be transferred',
     type: 'string',
-    example: '0x12345678',
+    example: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
   })
   @IsAsset()
   readonly asset: string;