Skip to content

eSIM Management APIs and General Description for the eSIM APIs#23

Open
rkandoi wants to merge 5 commits intocamaraproject:mainfrom
rkandoi:esim_v1
Open

eSIM Management APIs and General Description for the eSIM APIs#23
rkandoi wants to merge 5 commits intocamaraproject:mainfrom
rkandoi:esim_v1

Conversation

@rkandoi
Copy link
Copy Markdown
Contributor

@rkandoi rkandoi commented Feb 25, 2026

What type of PR is this?

API Specification and General Description for eSIM Management functionality.

Special notes for reviewers:

This PR is created to make some of the work visible before MWC. It would be appreciated if you can perform an expedited review and we can merge this PR.

The version of the API is vwip and all changes needed as we progress the work are okay to make.

Changelog input

First version of the eSIM Management APIs covering eSIM state management operations

Copy link
Copy Markdown
Contributor

@maheshc01 maheshc01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

considering the this is an initial commit and would be good to have for visibility of the work done as part of the API working group during the MWC Barcelona event, I am good with this pull request.
We can consider addressing the review comments when we plan for a release candidate as par to fall release cycle.

@@ -0,0 +1,1270 @@
openapi: 3.0.3
info:
title: eSIM Management API
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

title mismatch with repo might throw exceptions during the automated checks in the release management process. Needs to be confirmed and updated

$ref: '#/components/responses/Generic422'

/esim/delete:
post:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not use DELETE?

'422':
$ref: '#/components/responses/Generic422'

/esim/set-fallback:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need a separate endpoint for setting fall back? Could we not make it part of the earlier POST call to include this information?


## Operation-Specific Identification

- **Download**: Requires both EID (target device) and ICCID (profile to install)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually download does not require ICCID. Download requires activation code. ICCID is not used during download per se. ICCID could be optional for tracking purposes.


The target of the eSIM operations is typically the eUICC on the device (as opposed to the cellular network).

**Terminology Note**: In this API, "eSIM" and "eSIM profile" refer to the same thing - downloadable connectivity configurations installed on eSIM hardware. We use "eSIM" for simplicity.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually "eSIM" more often means "eUICC", so using "eSIM" like this may confure readers. I would prefer that "eSIM profile" is used consistently, as it has much more clear meaning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants