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

Jump to bottom

Include OIDC securityScheme, format scopes and add x-correlator header #53

Merged
merged 8 commits into from
Oct 30, 2023
Merged

Include OIDC securityScheme, format scopes and add x-correlator header #53

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
92651f3
include oidc securityScheme, format scopes and add x-correlator header
fernandopradocabrillo Sep 7, 2023
7a92b46
change yaml file name
fernandopradocabrillo Sep 7, 2023
69c5981
Merge branch 'main' of https://github.com/fernandopradocabrillo/SimSw…
fernandopradocabrillo Sep 8, 2023
9bda743
remove x-correlator from PR
fernandopradocabrillo Sep 25, 2023
44e8b35
adding supported security schemes + version number
DT-DawidWroblewski Oct 9, 2023
02c42ac
keeping v.0.5.0-wip
DT-DawidWroblewski Oct 10, 2023
94cc561
refactor: security scheme update
DT-DawidWroblewski Oct 27, 2023
286f2cd
refactor: version update
DT-DawidWroblewski Oct 27, 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
76 changes: 54 additions & 22 deletions code/API_definitions/sim_swap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.4.1
version: 0.5.0-wip
externalDocs:
description: Product documentation at Camara
url: https://github.com/camaraproject/SimSwap
Expand All @@ -59,13 +59,14 @@ paths:
/retrieve-date:
post:
security:
- oAuth2ClientCredentials: []
fernandopradocabrillo marked this conversation as resolved.
Show resolved Hide resolved
- three_legged:
- retrieve-sim-swap-date
- openId:
- sim-swap:retrieve-date
tags:
- Retrieve SIM swap date
description: Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
operationId: retrieveSimSwapDate
parameters:
- $ref: "#/components/parameters/X-Correlator"
requestBody:
description: |
Create a SIM swap date request for a MSISDN identifier.
Expand All @@ -77,6 +78,9 @@ paths:
responses:
"200":
description: Contains information about SIM swap change
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -100,13 +104,14 @@ paths:
/check:
post:
security:
- oAuth2ClientCredentials: []
- three_legged:
- check-sim-swap
- openId:
- sim-swap:check
tags:
- Check SIM swap
description: Check if SIM swap has been performed during a past period
operationId: checkSimSwap
parameters:
- $ref: "#/components/parameters/X-Correlator"
requestBody:
description: |
Create a check SIM swap request for a MSISDN identifier.
Expand All @@ -118,6 +123,9 @@ paths:
responses:
"200":
description: Returns whether a SIM swap has been performed during a past period
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -140,21 +148,21 @@ paths:
$ref: "#/components/responses/Generic504"
components:
securitySchemes:
oAuth2ClientCredentials:
fernandopradocabrillo marked this conversation as resolved.
Show resolved Hide resolved
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
three_legged:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.example.com/authorize
tokenUrl: https://auth.example.com/token
scopes:
check-sim-swap: checkSimSwap operation
retrieve-sim-swap-date: retrieveSimSwapDate operation
openId:
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
Copy link

Choose a reason for hiding this comment

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

I know this is currently a WIP but, given the existence of extension grants, the .well-known/openid-configuration could include any grant type that has a defined urn. Could we not give some guidance to those looking to implement this via a description documenting what grant types they might find in openid-configuration for this API and which they won't?

Or is that just too controversial at the moment?

Copy link
Collaborator Author

@fernandopradocabrillo fernandopradocabrillo Oct 27, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

For the moment it's been agreed to not indicate further information inside the yaml. I think there are further details regarding this in the I&C workgroup.

Copy link

Choose a reason for hiding this comment

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

Can you point me to the agreement that says YAMLs must not say anything about what security schemes are applicable for that API?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm checking with my collegues and it seems I wasn't align with the final decisions on this topic and all the details. I'm sorry for the misunderstanding. From TEF we are align with what was decided in the TSC.
Would it be okey to merge this PR with the schemes and continue with the discussion of appropiate wording/way to put this information in a different issue?
It seems that this is something that affects all apis and we should document in the same way for all apis.

Copy link

Choose a reason for hiding this comment

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

OK, let's return to this topic later. It needs to be resolved before any release.

parameters:
X-Correlator:
name: X-Correlator
in: header
description: Correlation id for the different services
schema:
type: string
headers:
X-Correlator:
description: Correlation id for the different services
schema:
type: string
schemas:
SimSwapInfo:
type: object
Expand Down Expand Up @@ -217,6 +225,9 @@ components:
responses:
Generic400:
description: Problem with the client request
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -227,6 +238,9 @@ components:
message: Client specified an invalid argument, request body or query param
Generic401:
description: Authentication problem with the client request
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -237,6 +251,9 @@ components:
message: Request not authenticated due to missing, invalid, or expired credentials
Generic403:
description: Client does not have sufficient permission
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -247,6 +264,9 @@ components:
message: Client does not have sufficient permissions to perform this action
Generic404:
description: Resource Not Found
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -257,6 +277,9 @@ components:
message: SIM Swap can't be checked because the phone number is unknown.
Generic409:
description: Conflict
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -267,6 +290,9 @@ components:
message: Another request is created for the same MSISDN
Generic500:
description: Server error
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -277,6 +303,9 @@ components:
message: Server error
Generic503:
description: Service unavailable. Typically the server is down
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand All @@ -287,6 +316,9 @@ components:
message: Service unavailable
Generic504:
description: Request time exceeded. If it happens repeatedly, consider reducing the request complexity
headers:
X-Correlator:
$ref: '#/components/headers/X-Correlator'
content:
application/json:
schema:
Expand Down