Skip to content

Commit 4e0c60f

Browse files
authored
Merge pull request #25 from ChinaUnicomXiaoDongrui/main
update the yaml file about esim-remote-management api
2 parents 135920d + c2e32f5 commit 4e0c60f

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

‎code/API_definitions/esim-remote-management.yaml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,14 +251,17 @@ components:
251251
properties:
252252
timestamp:
253253
type: string
254+
format: date-time
254255
maxLength: 64
255256
description: Request timestamp in ISO 8601 format
256257
sequenceNum:
257258
type: string
259+
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
258260
maxLength: 64
259261
description: Sequence number for request tracking
260262
clientId:
261263
type: string
264+
pattern: "^[a-zA-Z0-9_\\-]{1,128}$"
262265
maxLength: 128
263266
description: Client identifier
264267
data:
@@ -269,6 +272,7 @@ components:
269272
properties:
270273
taskId:
271274
type: string
275+
pattern: "^[a-zA-Z0-9\\-]{1,64}$"
272276
maxLength: 64
273277
description: Task identifier returned from asynchronous operation
274278
BaseCmpRespProfileResultQueryResp:
@@ -277,14 +281,17 @@ components:
277281
properties:
278282
resultCode:
279283
type: string
284+
pattern: "^B[0-9]{6}$"
280285
maxLength: 32
281286
description: 'B100000 - success, other - fail'
282287
resultDesc:
283288
type: string
289+
pattern: "^[\\s\\S]{0,256}$"
284290
maxLength: 256
285291
description: Result description message
286292
sequenceNum:
287293
type: string
294+
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
288295
maxLength: 64
289296
description: Sequence number for response tracking
290297
data:
@@ -295,14 +302,17 @@ components:
295302
properties:
296303
taskId:
297304
type: string
305+
pattern: "^[a-zA-Z0-9\\-]{1,64}$"
298306
maxLength: 64
299307
description: Task identifier
300308
imei:
301309
type: string
310+
pattern: "^[0-9]{15}$"
302311
maxLength: 32
303312
description: Device IMEI number
304313
iccid:
305314
type: string
315+
pattern: "^[0-9]{19,20}$"
306316
maxLength: 32
307317
description: Card ICCID number
308318
operResult:
@@ -314,10 +324,12 @@ components:
314324
enum: [0, 1, 2]
315325
eId:
316326
type: string
327+
pattern: "^[A-Fa-f0-9]{32}$"
317328
maxLength: 64
318329
description: Device EID (eUICC Identifier)
319330
resultMsg:
320331
type: string
332+
pattern: "^[\\s\\S]{0,512}$"
321333
maxLength: 512
322334
description: Detailed result message
323335
BaseCmpReqProfileOperReq:
@@ -350,14 +362,17 @@ components:
350362
properties:
351363
eId:
352364
type: string
365+
pattern: "^[A-Fa-f0-9]{32}$"
353366
maxLength: 64
354367
description: Device EID
355368
imei:
356369
type: string
370+
pattern: "^[0-9]{15}$"
357371
maxLength: 32
358372
description: Device IMEI number
359373
iccid:
360374
type: string
375+
pattern: "^[0-9]{19,20}$"
361376
maxLength: 32
362377
description: Card ICCID number
363378
optType:
@@ -377,6 +392,7 @@ components:
377392
description: Maximum number of subscription events
378393
subscriptionExpireTime:
379394
type: string
395+
format: date-time
380396
maxLength: 32
381397
description: Subscription expiration time in ISO 8601 format
382398
BaseCmpRespProfileOperResp:
@@ -405,14 +421,17 @@ components:
405421
properties:
406422
eId:
407423
type: string
424+
pattern: "^[A-Fa-f0-9]{32}$"
408425
maxLength: 64
409426
description: Device EID
410427
imei:
411428
type: string
429+
pattern: "^[0-9]{15}$"
412430
maxLength: 32
413431
description: Device IMEI number
414432
iccid:
415433
type: string
434+
pattern: "^[0-9]{19,20}$"
416435
maxLength: 32
417436
description: Card ICCID number
418437
optType:
@@ -432,6 +451,7 @@ components:
432451
description: Maximum number of subscription events
433452
subscriptionExpireTime:
434453
type: string
454+
format: date-time
435455
maxLength: 32
436456
description: Subscription expiration time in ISO 8601 format
437457
BaseCmpReqEidProfileListReq:
@@ -440,14 +460,17 @@ components:
440460
properties:
441461
timestamp:
442462
type: string
463+
format: date-time
443464
maxLength: 64
444465
description: Request timestamp in ISO 8601 format
445466
sequenceNum:
446467
type: string
468+
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
447469
maxLength: 64
448470
description: Sequence number for request tracking
449471
clientId:
450472
type: string
473+
pattern: "^[a-zA-Z0-9_\\-]{1,128}$"
451474
maxLength: 128
452475
description: Client identifier
453476
data:
@@ -458,6 +481,7 @@ components:
458481
properties:
459482
eId:
460483
type: string
484+
pattern: "^[A-Fa-f0-9]{32}$"
461485
maxLength: 64
462486
description: Device EID to query profiles for
463487
BaseCmpRespEidProfileListResp:
@@ -466,14 +490,17 @@ components:
466490
properties:
467491
resultCode:
468492
type: string
493+
pattern: "^B[0-9]{6}$"
469494
maxLength: 32
470495
description: 'B100000 - success, other - fail'
471496
resultDesc:
472497
type: string
498+
pattern: "^[\\s\\S]{0,256}$"
473499
maxLength: 256
474500
description: Result description message
475501
sequenceNum:
476502
type: string
503+
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
477504
maxLength: 64
478505
description: Sequence number for response tracking
479506
data:
@@ -484,6 +511,7 @@ components:
484511
properties:
485512
imei:
486513
type: string
514+
pattern: "^[0-9]{15}$"
487515
maxLength: 32
488516
description: Device IMEI number
489517
profiles:
@@ -494,6 +522,7 @@ components:
494522
description: List of profiles on the device
495523
eId:
496524
type: string
525+
pattern: "^[A-Fa-f0-9]{32}$"
497526
maxLength: 64
498527
description: Device EID
499528
ProfileInfo:
@@ -502,6 +531,7 @@ components:
502531
properties:
503532
iccid:
504533
type: string
534+
pattern: "^[0-9]{19,20}$"
505535
maxLength: 32
506536
description: Card ICCID number
507537
enableStatus:
@@ -540,14 +570,17 @@ components:
540570
properties:
541571
eId:
542572
type: string
573+
pattern: "^[A-Fa-f0-9]{32}$"
543574
maxLength: 64
544575
description: Device EID
545576
imei:
546577
type: string
578+
pattern: "^[0-9]{15}$"
547579
maxLength: 32
548580
description: Device IMEI number
549581
iccid:
550582
type: string
583+
pattern: "^[0-9]{19,20}$"
551584
maxLength: 32
552585
description: Card ICCID number
553586
autoEnableType:
@@ -567,6 +600,7 @@ components:
567600
description: Maximum number of subscription events
568601
subscriptionExpireTime:
569602
type: string
603+
format: date-time
570604
maxLength: 32
571605
description: Subscription expiration time in ISO 8601 format
572606
BaseCmpRespProfileDownloadResp:
@@ -595,14 +629,17 @@ components:
595629
properties:
596630
eId:
597631
type: string
632+
pattern: "^[A-Fa-f0-9]{32}$"
598633
maxLength: 64
599634
description: Device EID
600635
imei:
601636
type: string
637+
pattern: "^[0-9]{15}$"
602638
maxLength: 32
603639
description: Device IMEI number
604640
iccid:
605641
type: string
642+
pattern: "^[0-9]{19,20}$"
606643
maxLength: 32
607644
description: Card ICCID number
608645
autoEnableType:
@@ -622,6 +659,7 @@ components:
622659
description: Maximum number of subscription events
623660
subscriptionExpireTime:
624661
type: string
662+
format: date-time
625663
maxLength: 32
626664
description: Subscription expiration time in ISO 8601 format
627665
XCorrelator:

0 commit comments

Comments
 (0)