Skip to content

Commit 2078f56

Browse files
committed
Include version in operation summary (#43)
1 parent ebd715b commit 2078f56

File tree

6 files changed

+23
-38
lines changed

6 files changed

+23
-38
lines changed

catalog/devicelocation/devicelocation_openapi.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,17 @@ externalDocs:
1515
description: Product documentation at Camara
1616
url: https://github.com/camaraproject/
1717
servers:
18-
- url: "{host}/location/{version}"
18+
- url: "{host}/location/v0"
1919
variables:
2020
host:
2121
default: sandbox.opengateway.telefonica.com/apigateway
2222
description: API gateway URL
23-
version:
24-
default: v0
25-
description: Version of the Device Location API
2623
paths:
2724
/verify:
2825
post:
2926
tags:
3027
- Verify a device location
31-
summary: Device Location /verify
28+
summary: Verify location v0.1
3229
security:
3330
- three_legged:
3431
- device-location-read

catalog/devicestatus/devicestatus_openapi.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,17 @@ externalDocs:
1515
description: Product documentation at CAMARA
1616
url: https://github.com/camaraproject/
1717
servers:
18-
- url: "{host}/device-status/{version}"
18+
- url: "{host}/device-status/v0"
1919
variables:
2020
host:
2121
default: sandbox.opengateway.telefonica.com/apigateway
2222
description: API gateway URL
23-
version:
24-
default: v0
25-
description: Version of the Device Status API
2623
paths:
2724
/roaming:
2825
post:
29-
summary: Device Status /roaming
26+
summary: Check roaming status v0.4
3027
tags:
31-
- Get a device roaming status
28+
- Get a device status
3229
security:
3330
- three_legged:
3431
- device-status-roaming-read

catalog/knowyourcustomer/kyc_match_openapi.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ tags:
6060
paths:
6161
/v0/match:
6262
post:
63-
summary: KYC Match v0.1 /match
63+
summary: Verify match v0.1
6464
tags:
65-
- Match a customer identity
65+
- Verify a customer identity
6666

6767
description: |
6868
Matches a customer identity by checking a set of attributes related against the account data bound to their phone number.
@@ -168,11 +168,15 @@ paths:
168168
$ref: '#/components/responses/Generic504'
169169
/v0.2/match:
170170
post:
171-
summary: KYC Match v0.2 /match
171+
summary: Verify match v0.2
172172
tags:
173-
- Match a customer identity
173+
- Verify a customer identity
174174

175175
description: |
176+
Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
177+
178+
`dpv:FraudPreventionAndDetection#kyc-match:match`
179+
176180
Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.
177181
178182
In order to proceed with the match check, some Operators may have the requirement to perform an additional level of validation based on the `idDocument` property. This means that, in those cases, the `idDocument` is required and the provided value needs to match the one stored in the Operator system associated with the indicated `phoneNumber`. This validation will be done before proceeding with the match check of the rest of the properties. The following two rules apply only in the cases where the Operator have the requirement to validate the `idDocument`:
@@ -185,10 +189,6 @@ paths:
185189
- **false**: the attribute provided does not match with the one in the Operator systems.
186190
- **not_available**: the attribute is not available to validate.
187191
188-
Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
189-
190-
`dpv:FraudPreventionAndDetection#kyc`
191-
192192
operationId: KYC_Match_v0.2
193193

194194
security:

catalog/numberverification/numberverification_openapi.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,15 @@ info:
3535
name: Apache 2.0
3636
url: https://www.apache.org/licenses/LICENSE-2.0.html
3737
servers:
38-
- url: "{host}/number-verification/{version}"
38+
- url: "{host}/number-verification/v0"
3939
variables:
4040
host:
4141
default: sandbox.opengateway.telefonica.com/apigateway
4242
description: gateway URL
43-
version:
44-
default: v0
45-
description: Version of the Number Verification API
4643
paths:
4744
/verify:
4845
post:
49-
summary: Number Verification /verify
46+
summary: Verify number v0.3
5047
tags:
5148
- Verify a phone number
5249
description: |

catalog/qod/qod_openapi.yaml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,15 @@ info:
1313
name: Apache 2.0
1414
url: https://www.apache.org/licenses/LICENSE-2.0.html
1515
servers:
16-
- url: "{host}/qod/{version}"
16+
- url: "{host}/qod/v0"
1717
variables:
1818
host:
1919
default: sandbox.opengateway.telefonica.com/apigateway
2020
description: API gateway URL
21-
version:
22-
default: v0
23-
description: Version of the QoD API
2421
paths:
2522
/sessions:
2623
post:
27-
summary: QoD /sessions
24+
summary: Create QoD session v0.8
2825
tags:
2926
- QoD sessions
3027
security:
@@ -124,7 +121,7 @@ paths:
124121
$ref: "#/components/responses/Generic503"
125122
/sessions/{sessionId}:
126123
get:
127-
summary: QoD /sessions
124+
summary: Check QoD session v0.8
128125
tags:
129126
- QoD sessions
130127
description: |
@@ -170,7 +167,7 @@ paths:
170167
"503":
171168
$ref: "#/components/responses/Generic503"
172169
delete:
173-
summary: QoD /sessions
170+
summary: Cancel QoD session v0.8
174171
tags:
175172
- QoD sessions
176173
description: |
@@ -213,7 +210,7 @@ paths:
213210
$ref: "#/components/responses/Generic503"
214211
/notifications:
215212
post:
216-
summary: QoD /notifications
213+
summary: Listen for QoD notifications v0.8
217214
tags:
218215
- Session notifications callback
219216
security:

catalog/simswap/simswap_openapi.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,15 @@ externalDocs:
2525
description: Product documentation at Camara
2626
url: https://github.com/camaraproject/
2727
servers:
28-
- url: "{host}/sim-swap/{version}"
28+
- url: "{host}/sim-swap/v0"
2929
variables:
3030
host:
3131
default: sandbox.opengateway.telefonica.com/apigateway
3232
description: API gateway URL
33-
version:
34-
default: v0
35-
description: Version of the SIM Swap API
3633
paths:
3734
/check:
3835
post:
39-
summary: SIM Swap /check
36+
summary: Check SIM Swap v0.4
4037
tags:
4138
- Check for a SIM swap
4239
security:
@@ -82,7 +79,7 @@ paths:
8279
$ref: "#/components/responses/Generic504"
8380
/retrieve-date:
8481
post:
85-
summary: SIM Swap /retrieve-date
82+
summary: Retrieve last SIM Swap date v0.4
8683
tags:
8784
- Retrieve latest SIM swap date
8885
security:

0 commit comments

Comments
 (0)