camaraproject / SimSwap

Repository to describe, develop, document and test the Sim Swap API family
https://wiki.camaraproject.org/x/DgSeAQ
Apache License 2.0
22 stars 21 forks source link

Inconsistent usage of MSISDN and phoneNumber #112

Closed gregory1g closed 2 months ago

gregory1g commented 3 months ago

Problem description Communalities guided to use "common public" language in the API. Phone number instead of MSISDN was an example used there. The API payload follows this guideline uses "phoneNumber", however documentation for this payload sometimes does not. This can cause some confusions (actually already did). Example: image

There are 2 issues here: 1) confusion for a reader: If the API creates request for a MSISDN, why the attribute is called phoneNumber and if it is the same? 2) documentation is a place where it is especially important to use a developer friendly language (and above this is exact opposite)

Expected action Use phone number everywhere. Only use MSISDN/IMSI in the explanation what is considered as a SimSwap only.

Additional context

bigludo7 commented 2 months ago

@gregory1g we can close this one as https://github.com/camaraproject/SimSwap/pull/116 is merged - correct?

gregory1g commented 2 months ago

covered with changed done in scope of pullrequest #116