cleaning up repo #48
cleaning up repo #48
Conversation
There was a problem hiding this comment.
Not sure if the reference to Mobile Connect clarifies anything about usage or will distract the developer
There was a problem hiding this comment.
Mobile Connect APIs exists in API universe and this CAMARA API derives from it (Mobile Connect Account Takeover Protection were used in discussions around this product). CAMARA aims to deliver a solution for broad community of developers, so let's stick to it when crafting this API
There was a problem hiding this comment.
The reference makes sense from my perspective.
Text proposed by @diegogonmar and @bigludo7 in camaraproject/NumberVerification#51 (comment) now used for that.
| @@ -1,6 +1,7 @@ | |||
| # Overview | |||
|
|
|||
| The SIM Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period. | |||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). | |||
There was a problem hiding this comment.
same as previous comment
There was a problem hiding this comment.
Plese review @diegogonmar comments on this topic raised in Number Verification too: camaraproject/NumberVerification#51 (comment)
There was a problem hiding this comment.
commented there as well...
comment
There was a problem hiding this comment.
Text as proposed in camaraproject/NumberVerification#51 (comment) is now used as reference within YAML and MD. Consolidating the .md based documentation into the .yaml to be done in a separate issue/PR.
| # Overview | ||
|
|
||
| The SIM Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period. | ||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). |
|
|
||
| Depending on the network provider implementation, legal enforcement, etc... either one or both resources could be implemented. | ||
|
|
||
| __Note__: SIM swap is covered as well in the Mobile Connect (MC) ATP (Account-Takeover-Protection) process. The MC pattern is exposed in another Camara API from the SIM Swap API family. Network providers are free to implement the MC version, this version, or both. |
|
|
||
| Please note, the credentials for API authentication purposes need to be adjusted based on target security system configuration. | ||
|
|
||
| | Snippet 1. Request last simswap date | |
There was a problem hiding this comment.
Nice work of documentation, I like the snippets.
There was a problem hiding this comment.
Agree, great idea!
There was a problem hiding this comment.
this is good!
There was a problem hiding this comment.
Similar comments as in this PR: camaraproject/NumberVerification#51
| @@ -1,6 +1,7 @@ | |||
| # Overview | |||
|
|
|||
| The SIM Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period. | |||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). | |||
There was a problem hiding this comment.
Plese review @diegogonmar comments on this topic raised in Number Verification too: camaraproject/NumberVerification#51 (comment)
|
|
||
| SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account. | ||
|
|
||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). |
There was a problem hiding this comment.
Hi @DT-DawidWroblewski! I have been reviewing the discussions that have been made concerning this topic and in this issue camaraproject/WorkingGroups#200 it was concluded that the MC proposal should be removed since it's only causing confusion and noise in the repo. This is also the solution agreed in the GSMA workshop.
The relation with MC should be in the documentation .md file and not in the yaml. Yaml is API spec and has to stick to API Definition.
@diegogonmar left comments regarding this topic that should be applied here too.
There was a problem hiding this comment.
According to what has been approved in the working groups discussion please, remove this part from the yaml since it is already compiled in the documentation md file documentation/API_documentation/Check_sim_swap_API.md
There was a problem hiding this comment.
Hi!
if we're aiming to have only yaml file that describes API, then it should contain a proper description, that includes reference to Mobile Connect.
Afterwards, we can delete markdown, although I think that we should keep it as MD files works perfectly to provide additional content (e.g. pictures, diagrams, etc.)
There was a problem hiding this comment.
I tend to be agreed with @fernandopradocabrillo. If we keep there mention of Mobile Connect while the API did not fulfill MC pattern, don't you think @DT-DawidWroblewski that it can trigger confusion for application developer, WDYT?
There was a problem hiding this comment.
As above: Text as proposed in camaraproject/NumberVerification#51 (comment) is now used as reference within YAML and MD. Consolidating the .md based documentation into the .yaml to be done in a separate issue/PR.
| @@ -1,6 +1,7 @@ | |||
| # Overview | |||
|
|
|||
| The SIM Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period. | |||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). | |||
There was a problem hiding this comment.
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). | |
| This API considers as a source input the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). | |
There was a problem hiding this comment.
Text as proposed in camaraproject/NumberVerification#51 (comment) is now used as reference within YAML and MD. Consolidating the .md based documentation into the .yaml to be done in a separate issue/PR.
There was a problem hiding this comment.
Great thanks. Ok to consolidating .md in different PR
|
|
||
| SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account. | ||
|
|
||
| This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/). |
There was a problem hiding this comment.
According to what has been approved in the working groups discussion please, remove this part from the yaml since it is already compiled in the documentation md file documentation/API_documentation/Check_sim_swap_API.md
| @@ -75,10 +37,8 @@ Described inside yaml files. | |||
| |No|Version|Changelog| | |||
| |:---:|---:|:---| | |||
| |1|0.5.0|Camara & Mobile Connect flavours available| | |||
| |2|0.6.0|Camara only version<br>(Mobile Connect archived)| | |||
There was a problem hiding this comment.
@DT-DawidWroblewski We fully believe that, according what has been agreed, the reference to MC should remain just as a source of input and with these changes we state perfectly that relation. We think it is better to remove all files, if you consider that, for history purposes, it should remain in the changelog, please consider this wording.
| |2|0.6.0|Camara only version<br>(Mobile Connect archived)| | |
| |2|0.6.0|Camara only version<br>(Mobile Connect proposal removed. Moved as supporting documentation to documentation/SupportingDocuments/Removed/MobileConnect)| |
There was a problem hiding this comment.
One thing no note here, current version of the API is 0.4.0, is the changelog correct? I'm probably missing something but, as it is right now, I think it's not clear enough.
There was a problem hiding this comment.
I'd suggest to use following statement here:
|2|0.6.0|Camara only version
(Mobile Connect moved as supporting documentation to documentation/SupportingDocuments/MobileConnect)|
as well as delete the yaml file and leave MC specifications only as a referenced/supporting docs
There was a problem hiding this comment.
Include the reference is fine, but there is no point in maintaining MC specifications in this repo. A reference is a link to a place where documentation is, replicating such documentation in this repo has no utility, will cause confusion and will become obsolete. For example for dates we use RFC3339 and we reference it, but we don't have a copy of such RFC in the commonalities repo.
There was a problem hiding this comment.
File path should be: documentation/SupportingDocuments/Removed/MobileConnect/MC_ATP.yaml
There was a problem hiding this comment.
Files should be removed actually
There was a problem hiding this comment.
File path should be: documentation/SupportingDocuments/Removed/MobileConnect/MobileConnectATP.md
There was a problem hiding this comment.
CAMARA folder no longer needed, the path for the Check_sim_swap_API.md should be: documentation/API_documentation/Check_sim_swap_API.md
I was thinking that we can even explore the option of removing the documentation/API_documentation/README.md file completely and incorporate the relevant information into Check_sim_swap_API.md. What do you think @patrice-conil @DT-DawidWroblewski?
There was a problem hiding this comment.
I'm not the biggest fan of having only yaml as a documentation. If we can provide a sufficient documentation artifacts, like pictures, diagrams, code snippets inside yaml, then I'm fine with keeping only yaml.
There was a problem hiding this comment.
@DT-DawidWroblewski this is a commonalities decision. Looks on QoD API - seems to me that we can provide nice documentation with picture, etc...
There was a problem hiding this comment.
Yes, I also didn't realize that when I raised some comments about .md. We have to follow commonalities, so please lets move forward with removing these to have the repo clean, while in parallel we agree with the reference wording
There was a problem hiding this comment.
Consolidating the .md based documentation into the .yaml to be done in a separate issue/PR. It would overload the purpose of this PR.
|
|
||
| Depending on the network provider implementation, legal enforcement, etc... either one or both resources could be implemented. | ||
|
|
||
| __Note__: SIM swap is covered as well in the Mobile Connect (MC) ATP (Account-Takeover-Protection) process. The MC pattern is exposed in another Camara API from the SIM Swap API family. Network providers are free to implement the MC version, this version, or both. |
There was a problem hiding this comment.
According to what has been agreed, this information is no longer valid and should be removed too
|
Dear all,
We are just integrating the SimSwap API from https://github.com/camaraproject/SimSwap/blob/main/documentation/API_documentation/CAMARA/Check_sim_swap_API.md and have one question regarding the response:
response will be:
200
-d '{ "swapped": "false" }'
In your sample the boolean value “swapped” is actually of type string. Is that a typo or intentionally?
Best Regards
Stefan Engelbert
Aloaha Software
----------------------------------------------------------------------------------------------------------------------------------
***@***.***<https://www.aloaha.com/>
M: +356 79 567 034
T: +49 541 3859 4554
***@***.***
https://www.aloaha.com<https://www.aloaha.com/>
https://www.codeb.io<https://www.codeb.io/>
***@***.***<https://play.google.com/store/apps/details?id=com.codeb.sms>
CodeB SMS
***@***.***<https://www.linkedin.com/company/codeb>
***@***.***<https://www.youtube.com/channel/UCSDcRoxoc1XBUOMhhJD2eGA>
***@***.***<https://twitter.com/aloaha>
From: Fernando Prado Cabrillo ***@***.***
Sent: 10 August 2023 15:52
To: camaraproject/SimSwap ***@***.***>
Cc: Subscribed ***@***.***>
Subject: Re: [camaraproject/SimSwap] cleaning up repo (PR #48)
@fernandopradocabrillo commented on this pull request.
________________________________
In code/API_definitions/checkSimSwap.camara.swagger.yaml<#48 (comment)>:
@@ -2,9 +2,9 @@ openapi: 3.0.3
info:
title: SIM Swap
description: |
- SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change
- related to the User's mobile account.
-
+ SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account.
+
+ This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/).
Hi @DT-DawidWroblewski<https://github.com/DT-DawidWroblewski>! I have been reviewing the discussions that have been made concerning this topic and in this issue camaraproject/WorkingGroups#200<camaraproject/WorkingGroups#200> it was concluded that the MC proposal should be removed since it's only causing confusion and noise in the repo. This is also the solution agreed in the GSMA workshop.
The relation with MC should be in the documentation .md file and not in the yaml. Yaml is API spec and has to stick to API Definition.
@diegogonmar<https://github.com/diegogonmar> left comments regarding this topic that should be applied here too.
________________________________
In documentation/API_documentation/CAMARA/Check_sim_swap_API.md<#48 (comment)>:
@@ -1,6 +1,7 @@
# Overview
The SIM Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a SIM swap performed on the mobile line, or, to check whether a SIM swap has been performed during a past period.
+This API derives from the GSMA Mobile Connect Account Takeover Protection specification [Mobile Connect Account Takeover Protection](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf). For more about Mobile Connect, please see [about Mobile Connect](https://mobileconnect.io/).
Plese review @diegogonmar<https://github.com/diegogonmar> comments on this topic raised in Number Verification too: camaraproject/NumberVerification#51 (comment)<camaraproject/NumberVerification#51 (comment)>
—
Reply to this email directly, view it on GitHub<#48 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AA4AXVNNE5CRM3GBPPSFMI3XUTRQDANCNFSM6AAAAAA2YQXEKE>.
You are receiving this because you are subscribed to this thread.Message ID: ***@***.******@***.***>>
|
|
Hi @DT-DawidWroblewski! Please take a look at the proposed changes to continue with the implementation and complete de clean up. Thanks!! |
Co-authored-by: Fernando Prado Cabrillo <pradocabrillo.fernando@gmail.com>
ok Co-authored-by: Fernando Prado Cabrillo <pradocabrillo.fernando@gmail.com>
Hi @engst03 . This looks like a typo in the .md. This .md file will be removed, the normative file is the .yaml and there it's fine, its a boolean |
| @@ -18,10 +18,10 @@ info: | |||
| license: | |||
| name: Apache 2.0 | |||
| url: https://www.apache.org/licenses/LICENSE-2.0.html | |||
| version: 0.4.0 | |||
| version: 0.6.1 | |||
There was a problem hiding this comment.
Why version 0.6.1 ? I would suggest maintainging 0.4.0 as no changes in interface but only documentation. 0.4.1 could be another option, no strong opinion
There was a problem hiding this comment.
Fine with the approach discussed and agreed, thanks for the effort @DT-DawidWroblewski and @hdamker.
Just one last comment, PR moves version from 0.4.0 to 0.6.1, which looks strange. Please fix that, thanks
What type of PR is this?
What this PR does / why we need it:
clean up repo
Which issue(s) this PR fixes:
Fixes #27
Fixes #26
Fixes #25
Fixes #10
Special notes for reviewers:
cleans up repo
Changelog input
Additional documentation