Merge branch 'main' into prepare-release-r1.2

README.md

@@ -10,9 +10,11 @@
 Repository to describe, develop, document and test the DeviceStatus API family
 
 ## Scope
-* Service APIs for “Device Status” (see APIBacklog.md)  
+* Service APIs for “Device Status” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))  
 * It provides the customer with the ability to:  
-  * check if a device is losing connection to the network or gets reachable again, and the roaming status.
+  - check if a device is reachable or has lost connectivity to the network
+  - check if a device is roaming, and in which country
+  - receive notifications if the connectivity or roaming status of the device changes
 * Describe, develop, document and test the APIs (with 1-2 Telcos)  
 * Started: July 2022 
 

code/API_definitions/device-reachability-status.yaml

@@ -110,8 +110,6 @@ paths:
           $ref: "#/components/responses/Generic403"
         "404":
           $ref: "#/components/responses/Generic404"
-        "405":
-          $ref: "#/components/responses/Generic405"
         "406":
           $ref: "#/components/responses/Generic406"
         "415":
@@ -361,22 +359,6 @@ components:
                 status: 404
                 code: DEVICE_NOT_FOUND
                 message: Some identifier cannot be matched to a device
-    Generic405:
-      description: Method Not Allowed
-      headers:
-        x-correlator:
-          $ref: "#/components/headers/x-correlator"
-      content:
-        application/json:
-          schema:
-            $ref: "#/components/schemas/ErrorInfo"
-          examples:
-            GENERIC_405_METHOD_NOT_ALLOWED:
-              description: Invalid HTTP verb used with a given endpoint
-              value:
-                status: 405
-                code: METHOD_NOT_ALLOWED
-                message: The requested method is not allowed/supported on the target resource.
     Generic406:
       description: Not Acceptable
       headers:

code/API_definitions/device-roaming-status-subscriptions.yaml

@@ -907,13 +907,17 @@ components:
     TerminationReason:
       type: string
       description: |
-        NETWORK_TERMINATED - API server stopped sending notification
-        SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached
-        SUBSCRIPTION_DELETED - Subscription was deleted by the requester
+        - NETWORK_TERMINATED - API server stopped sending notification
+        - SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached
+        - SUBSCRIPTION_DELETED - Subscription was deleted by the requester
+        - MAX_EVENTS_REACHED - Maximum number of events (optionally set by the requester) has been reached
+        - ACCESS_TOKEN_EXPIRED - Access Token sinkCredential (optionally set by the requester) expiration time has been reached
       enum:
         - NETWORK_TERMINATED
         - SUBSCRIPTION_EXPIRED
         - SUBSCRIPTION_DELETED
+        - MAX_EVENTS_REACHED
+        - ACCESS_TOKEN_EXPIRED
 
   responses:
     CreateSubscriptionBadRequest400:

code/API_definitions/device-roaming-status.yaml

@@ -125,8 +125,6 @@ paths:
           $ref: "#/components/responses/Generic403"
         "404":
           $ref: "#/components/responses/Generic404"
-        "405":
-          $ref: "#/components/responses/Generic405"
         "406":
           $ref: "#/components/responses/Generic406"
         "415":
@@ -385,22 +383,6 @@ components:
                 status: 404
                 code: DEVICE_NOT_FOUND
                 message: Some identifier cannot be matched to a device
-    Generic405:
-      description: Method Not Allowed
-      headers:
-        x-correlator:
-          $ref: "#/components/headers/x-correlator"
-      content:
-        application/json:
-          schema:
-            $ref: "#/components/schemas/ErrorInfo"
-          examples:
-            GENERIC_405_METHOD_NOT_ALLOWED:
-              description: Invalid HTTP verb used with a given endpoint
-              value:
-                status: 405
-                code: METHOD_NOT_ALLOWED
-                message: The requested method is not allowed/supported on the target resource.
     Generic406:
       description: Not Acceptable
       headers: