Skip to content
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

cleaning up repo #48

Merged
merged 5 commits into from
Sep 3, 2023
Merged

cleaning up repo #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6843563
cleaning repo
DT-DawidWroblewski Jul 26, 2023
84c5ae2
Update documentation/API_documentation/README.MD
DT-DawidWroblewski Aug 30, 2023
5d4241a
Update documentation/API_documentation/README.MD
DT-DawidWroblewski Aug 30, 2023
4082cd3
adding fixes to PR
DT-DawidWroblewski Sep 1, 2023
6f07d45
Merge branch 'main' of https://github.com/DT-DawidWroblewski/SimSwap
DT-DawidWroblewski Sep 1, 2023
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
202 changes: 0 additions & 202 deletions code/API_definitions/MobileConnect/MC_ATP.yaml
View file
Open in desktop

This file was deleted.

Empty file removed code/API_definitions/README.MD
View file
Open in desktop
Empty file.
10 changes: 5 additions & 5 deletions ...s/CAMARA/checkSimSwap.camara.swagger.yaml → ...initions/checkSimSwap.camara.swagger.yaml
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

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

Not sure if the reference to Mobile Connect clarifies anything about usage or will distract the developer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

The reference makes sense from my perspective.

Text proposed by @diegogonmar and @bigludo7 in camaraproject/NumberVerification#51 (comment) now used for that.

Original file line number Diff line number Diff line change
Expand Up @@ -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.

[GSMA Mobile Connect Account Takeover Protection specification](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf) was used as source of input for this API. For more about Mobile Connect, please see [Mobile Connect website](https://mobileconnect.io/).

The API provides 2 operations:

Expand All @@ -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
Copy link

Choose a reason for hiding this comment

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

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

externalDocs:
description: Product documentation at Camara
url: https://github.com/camaraproject/
url: https://github.com/camaraproject/SimSwap
servers:
- url: "{apiRoot}/{basePath}"
variables:
Expand Down
Loading