Skip to content

update the yaml file about esim-remote-management api #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SentianSun merged 1 commit into from
Aug 3, 2026
Merged

update the yaml file about esim-remote-management api #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions code/API_definitions/esim-remote-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,16 +249,19 @@
type: object
description: Request body for querying profile operation result
properties:
timestamp:

Check notice on line 252 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 64
description: Request timestamp in ISO 8601 format
sequenceNum:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
maxLength: 64
description: Sequence number for request tracking
clientId:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,128}$"
maxLength: 128
description: Client identifier
data:
Expand All @@ -269,6 +272,7 @@
properties:
taskId:
type: string
pattern: "^[a-zA-Z0-9\\-]{1,64}$"
maxLength: 64
description: Task identifier returned from asynchronous operation
BaseCmpRespProfileResultQueryResp:
Expand All @@ -277,14 +281,17 @@
properties:
resultCode:
type: string
pattern: "^B[0-9]{6}$"
maxLength: 32
description: 'B100000 - success, other - fail'
resultDesc:
type: string
pattern: "^[\\s\\S]{0,256}$"
maxLength: 256
description: Result description message
sequenceNum:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
maxLength: 64
description: Sequence number for response tracking
data:
Expand All @@ -295,14 +302,17 @@
properties:
taskId:
type: string
pattern: "^[a-zA-Z0-9\\-]{1,64}$"
maxLength: 64
description: Task identifier
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
operResult:
Expand All @@ -314,10 +324,12 @@
enum: [0, 1, 2]
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID (eUICC Identifier)
resultMsg:
type: string
pattern: "^[\\s\\S]{0,512}$"
maxLength: 512
description: Detailed result message
BaseCmpReqProfileOperReq:
Expand All @@ -326,14 +338,14 @@
properties:
protocol:
$ref: '#/components/schemas/Protocol'
sink:

Check notice on line 341 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: Callback address (sink address for notification reception)
types:
type: array
maxItems: 10
items:

Check notice on line 348 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: Event type identifier
Expand All @@ -350,14 +362,17 @@
properties:
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
optType:
Expand All @@ -375,8 +390,9 @@
minimum: 1
maximum: 1000
description: Maximum number of subscription events
subscriptionExpireTime:

Check notice on line 393 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 32
description: Subscription expiration time in ISO 8601 format
BaseCmpRespProfileOperResp:
Expand All @@ -389,7 +405,7 @@
minimum: 0
maximum: 999999
description: Response code
message:

Check notice on line 408 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: Response message
Expand All @@ -405,14 +421,17 @@
properties:
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
optType:
Expand All @@ -430,24 +449,28 @@
minimum: 1
maximum: 1000
description: Maximum number of subscription events
subscriptionExpireTime:

Check notice on line 452 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 32
description: Subscription expiration time in ISO 8601 format
BaseCmpReqEidProfileListReq:
type: object
description: Request body for querying profile list
properties:
timestamp:

Check notice on line 461 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 64
description: Request timestamp in ISO 8601 format
sequenceNum:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
maxLength: 64
description: Sequence number for request tracking
clientId:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,128}$"
maxLength: 128
description: Client identifier
data:
Expand All @@ -458,6 +481,7 @@
properties:
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID to query profiles for
BaseCmpRespEidProfileListResp:
Expand All @@ -466,14 +490,17 @@
properties:
resultCode:
type: string
pattern: "^B[0-9]{6}$"
maxLength: 32
description: 'B100000 - success, other - fail'
resultDesc:
type: string
pattern: "^[\\s\\S]{0,256}$"
maxLength: 256
description: Result description message
sequenceNum:
type: string
pattern: "^[a-zA-Z0-9_\\-]{1,64}$"
maxLength: 64
description: Sequence number for response tracking
data:
Expand All @@ -484,6 +511,7 @@
properties:
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
profiles:
Expand All @@ -494,6 +522,7 @@
description: List of profiles on the device
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID
ProfileInfo:
Expand All @@ -502,6 +531,7 @@
properties:
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
enableStatus:
Expand All @@ -516,14 +546,14 @@
properties:
protocol:
$ref: '#/components/schemas/Protocol'
sink:

Check notice on line 549 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 256
description: Callback address (sink address for notification reception)
types:
type: array
maxItems: 10
items:

Check notice on line 556 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: Event type identifier
Expand All @@ -540,14 +570,17 @@
properties:
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
autoEnableType:
Expand All @@ -565,8 +598,9 @@
minimum: 1
maximum: 1000
description: Maximum number of subscription events
subscriptionExpireTime:

Check notice on line 601 in code/API_definitions/esim-remote-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

date-time field must mention RFC 3339 

[S-028] Property with format 'date-time' must have a description mentioning RFC\s*3339
type: string
format: date-time
maxLength: 32
description: Subscription expiration time in ISO 8601 format
BaseCmpRespProfileDownloadResp:
Expand Down Expand Up @@ -595,14 +629,17 @@
properties:
eId:
type: string
pattern: "^[A-Fa-f0-9]{32}$"
maxLength: 64
description: Device EID
imei:
type: string
pattern: "^[0-9]{15}$"
maxLength: 32
description: Device IMEI number
iccid:
type: string
pattern: "^[0-9]{19,20}$"
maxLength: 32
description: Card ICCID number
autoEnableType:
Expand All @@ -622,6 +659,7 @@
description: Maximum number of subscription events
subscriptionExpireTime:
type: string
format: date-time
maxLength: 32
description: Subscription expiration time in ISO 8601 format
XCorrelator:
Expand Down