Include version in operation summary (#43)

Telefonica · Nov 19, 2024 · 2078f56 · 2078f56
1 parent ebd715b
commit 2078f56
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 38 deletions.
diff --git a/catalog/devicelocation/devicelocation_openapi.yaml b/catalog/devicelocation/devicelocation_openapi.yaml
@@ -15,20 +15,17 @@ externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/
 servers:
-  - url: "{host}/location/{version}"
+  - url: "{host}/location/v0"
     variables:
       host:
         default: sandbox.opengateway.telefonica.com/apigateway
         description: API gateway URL
-      version:
-        default: v0
-        description: Version of the Device Location API
 paths:
   /verify:
     post:
       tags:
         - Verify a device location
-      summary: Device Location /verify
+      summary: Verify location v0.1
       security: 
         - three_legged:
           - device-location-read

diff --git a/catalog/devicestatus/devicestatus_openapi.yaml b/catalog/devicestatus/devicestatus_openapi.yaml
@@ -15,20 +15,17 @@ externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/
 servers:
-  - url: "{host}/device-status/{version}"
+  - url: "{host}/device-status/v0"
     variables:
       host:
         default: sandbox.opengateway.telefonica.com/apigateway
         description: API gateway URL
-      version:
-        default: v0
-        description: Version of the Device Status API
 paths:
    /roaming:
     post:
-      summary: Device Status /roaming
+      summary: Check roaming status v0.4
       tags:
-        - Get a device roaming status
+        - Get a device status
       security:
         - three_legged:
           - device-status-roaming-read

diff --git a/catalog/knowyourcustomer/kyc_match_openapi.yaml b/catalog/knowyourcustomer/kyc_match_openapi.yaml
@@ -60,9 +60,9 @@ tags:
 paths:
   /v0/match:
     post:
-      summary: KYC Match v0.1 /match
+      summary: Verify match v0.1
       tags:
-        - Match a customer identity
+        - Verify a customer identity
 
       description: |
         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:
           $ref: '#/components/responses/Generic504'
   /v0.2/match:
     post:
-      summary: KYC Match v0.2 /match
+      summary: Verify match v0.2
       tags:
-        - Match a customer identity      
+        - Verify a customer identity      
 
       description: |
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:FraudPreventionAndDetection#kyc-match:match`
+
         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.
 
         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:
           - **false**: the attribute provided does not match with the one in the Operator systems.
           - **not_available**: the attribute is not available to validate.
         
-        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
-
-        `dpv:FraudPreventionAndDetection#kyc`
-
       operationId: KYC_Match_v0.2
 
       security:

diff --git a/catalog/numberverification/numberverification_openapi.yaml b/catalog/numberverification/numberverification_openapi.yaml
@@ -35,18 +35,15 @@ info:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
 servers:
-  - url: "{host}/number-verification/{version}"
+  - url: "{host}/number-verification/v0"
     variables:
       host:
         default: sandbox.opengateway.telefonica.com/apigateway
         description: gateway URL
-      version:
-        default: v0
-        description: Version of the Number Verification API
 paths:
   /verify:
     post:
-      summary: Number Verification /verify
+      summary: Verify number v0.3
       tags: 
         -  Verify a phone number
       description: |

diff --git a/catalog/qod/qod_openapi.yaml b/catalog/qod/qod_openapi.yaml
@@ -13,18 +13,15 @@ info:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
 servers:
-  - url: "{host}/qod/{version}"
+  - url: "{host}/qod/v0"
     variables:
       host:
         default: sandbox.opengateway.telefonica.com/apigateway
         description: API gateway URL
-      version:
-        default: v0
-        description: Version of the QoD API
 paths:
   /sessions:
     post:
-      summary: QoD /sessions
+      summary: Create QoD session v0.8
       tags:
         - QoD sessions
       security:
@@ -124,7 +121,7 @@ paths:
           $ref: "#/components/responses/Generic503"
   /sessions/{sessionId}:
     get:
-      summary: QoD /sessions
+      summary: Check QoD session v0.8
       tags:
         - QoD sessions
       description: |
@@ -170,7 +167,7 @@ paths:
         "503":
           $ref: "#/components/responses/Generic503"
     delete:
-      summary: QoD /sessions
+      summary: Cancel QoD session v0.8
       tags:
         - QoD sessions
       description: |
@@ -213,7 +210,7 @@ paths:
           $ref: "#/components/responses/Generic503"
   /notifications:
     post:
-      summary: QoD /notifications
+      summary: Listen for QoD notifications v0.8
       tags:
         - Session notifications callback
       security:

diff --git a/catalog/simswap/simswap_openapi.yaml b/catalog/simswap/simswap_openapi.yaml
@@ -25,18 +25,15 @@ externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/
 servers:
-  - url: "{host}/sim-swap/{version}"
+  - url: "{host}/sim-swap/v0"
     variables:
       host:
         default: sandbox.opengateway.telefonica.com/apigateway
         description: API gateway URL
-      version:
-        default: v0
-        description: Version of the SIM Swap API
 paths:
   /check:
     post:
-      summary: SIM Swap /check
+      summary: Check SIM Swap v0.4
       tags: 
         -  Check for a SIM swap
       security:
@@ -82,7 +79,7 @@ paths:
           $ref: "#/components/responses/Generic504"
   /retrieve-date:
     post:
-      summary: SIM Swap /retrieve-date
+      summary: Retrieve last SIM Swap date v0.4
       tags: 
         -  Retrieve latest SIM swap date
       security: