Armonize descriptions

Telefonica · Oct 18, 2024 · 6adf5c0 · 6adf5c0
1 parent 6ed7955
commit 6adf5c0
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 7 deletions.
diff --git a/callflows/authorization/authorization_openapi.yaml b/callflows/authorization/authorization_openapi.yaml
@@ -25,7 +25,7 @@ paths:
       security:
         - none: []
       description: |
-        Authorize an application to access a resource from the user device
+        Authorizes an application to access a resource from the user device
       operationId: authorize
       parameters: 
         - name: response_type
@@ -89,7 +89,7 @@ paths:
       security:
         - basicAuth: []
       description: |
-        Authorize an application to access a resource from the backend
+        Authorizes an application to access a resource from the backend
       operationId: bcAuthorize
       requestBody:
         content:
@@ -118,7 +118,7 @@ paths:
       security: 
         - basicAuth: []
       description: |
-        Retrieve an access token from the authorization code (frontend) or auth_req_id (backend)
+        Retrieves an access token from the authorization code (frontend) or auth_req_id (backend)
       operationId: token
       requestBody: 
         content:

diff --git a/catalog/devicelocation/devicelocation_openapi.yaml b/catalog/devicelocation/devicelocation_openapi.yaml
@@ -33,7 +33,7 @@ paths:
         - three_legged:
           - device-location-read
       description: |
-        Verify the location of a device with a given coordinates and accuracy
+        Verifies the location of a device with a given coordinates and accuracy
 
         Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
 

diff --git a/catalog/knowyourcustomer/kyc_match_openapi.yaml b/catalog/knowyourcustomer/kyc_match_openapi.yaml
@@ -67,6 +67,13 @@ paths:
       tags:
         - Match
 
+      description: |
+        Matches a customer identity by checking a set of attributes related against the account data bound to their phone number.
+
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:FraudPreventionAndDetection#kyc`
+
       operationId: KYC_Match
 
       security:

diff --git a/catalog/qod/qod_openapi.yaml b/catalog/qod/qod_openapi.yaml
@@ -32,7 +32,13 @@ paths:
       security:
         - three_legged:
           - qod
-      description: Creates a new QoS session on demand
+      description: |
+        Creates a new QoS session on demand
+
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:RequestedServiceProvision#qod`
+        
       operationId: createSession
       requestBody:
         description: Creates a new session
@@ -123,6 +129,13 @@ paths:
       summary: QoD /sessions
       tags:
         - QoD sessions
+      description: |
+        Gets information about an active QoS session
+
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:RequestedServiceProvision#qod`
+
       security:
         - three_legged:
           - qod
@@ -162,6 +175,13 @@ paths:
       summary: QoD /sessions
       tags:
         - QoD sessions
+      description: |
+        Cancels an active QoS session
+
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:RequestedServiceProvision#qod`
+        
       security:
         - three_legged:
           - qod
@@ -203,8 +223,14 @@ paths:
           - qod
       description: |
         Important: this endpoint is to be implemented by the API consumer.
+
         The QoD server will call this endpoint whenever any network related event occurs.
         Currently only SESSION_TERMINATED event is implemented. Any other network events are ignored.
+
+        Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
+
+        `dpv:RequestedServiceProvision#qod`
+
       operationId: postNotification
       requestBody:
         required: true

diff --git a/catalog/simswap/simswap_openapi.yaml b/catalog/simswap/simswap_openapi.yaml
@@ -43,7 +43,7 @@ paths:
         - three_legged:
           - check-sim-swap
       description: |
-        Check if SIM swap has been performed during a past period
+        Checks if SIM swap has been performed during a past period
 
         Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose:
 
@@ -89,7 +89,7 @@ paths:
         - three_legged:
           - retrieve-sim-swap-date  
       description: |
-        Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
+        Gets the timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
 
         Check the [Authorization guide](/docs/authorization) on how to get an OAuth2 token, with the following purpose: