diff --git a/README.md b/README.md
index 833f7576..61d41eb9 100644
--- a/README.md
+++ b/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
diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml
index 7ca9423a..6b4d859b 100644
--- a/code/API_definitions/device-reachability-status.yaml
+++ b/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:
diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml
index 0a9291ed..3259db66 100644
--- a/code/API_definitions/device-roaming-status-subscriptions.yaml
+++ b/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:
diff --git a/code/API_definitions/device-roaming-status.yaml b/code/API_definitions/device-roaming-status.yaml
index 98f867bd..43184a48 100644
--- a/code/API_definitions/device-roaming-status.yaml
+++ b/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:
diff --git a/documentation/API_documentation/Connectivity_API.md b/documentation/API_documentation/Connectivity_API.md
deleted file mode 100644
index 7faee5fa..00000000
--- a/documentation/API_documentation/Connectivity_API.md
+++ /dev/null
@@ -1,100 +0,0 @@
-# Overview
-This API makes possible to query the connectivity status of user equipment.
-
-## 1\. Introduction
-
-
-## 2\. Quick Start
-DeviceStatus API v0.4.1 exposes only one endpoint, which can be used to check roaming status for user equipment. To do so user has to pass following parameters in request body:
-1. **ueId** - an object with four fields, each of them make possible to pass ueId in different format: externalId [1], msisdn, ipv4Addr and ipv6Addr
-2. **uePort** - if a public ipv4Addr is provided for the ueId object, the port allocated to the UE must also be specified
-
-Sample API invocation is presented in Section 4.4.
-
-## 3\. Authentication and Authorization
-The Device Status API makes use of the client credentials grant which is applicable for server to server use cases involving trusted partners or clients without any protected user data involved. In this method the API invoker client is registered as a confidential client with an authorization grant type of client_credentials [2].
-
-## 4\. API Documentation
-The API user wants to execute a check of connectivity status for a user equipment. The current API version make possible to check only the roaming status of device with given identifier. It can be extended in the future with other connectivity types.
-
-
-### 4.1 Endpoint Definitions
-
-Following table
-defines API endpoints of exposed REST based for device status query operations.
-
-| **Endpoint** | **Operation** | **Description** |
-|-----------------------------------------|---------------------------|-------------------------------|
-| POST
\/device-status/v0/roaming | **Device Roaming Status** | Get the current roaming status |
-
-#### **Check device roaming status**
-
-| **Execute check of device roaming status** |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **HTTP Request**
POST \/device-status/v0/roaming
**QueryParameters**
No query parameters are defined.
-**Path Parameters**
No path parameters are defined.
**Request Body Parameters**
-**ueId**: UE identifier object, contains 4 different identifiers, at least 1 has to be set
-**uePort (optional):** User equipment port. Device port may be required along with IP address to identify the target device
-**Response**
**200: Roaming status checked**
**Response body:**
-**roaming:** Roaming status. True, if it is roaming
-**countryCode (optional):** The Mobile country code (MCC) as a geographic region identifier for the country and the dependent areas
-**countryName (optional):** The ISO 3166 ALPHA-2 country-codes of mapped the mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries. If there is no mapping of MCC to any country, then an empty array [] shall be returned.
-**400:** **Invalid input.**
-**401:** **Un-authorized, missing or incorrect authentication.**
-**403:** **Forbidden access.**
-**404:** **Resource not found.**
-**500:** **Server error.**
-**503:** **Service temporarily unavailable.** |
-**504:** **Request time exceeded.**
-
-
-### 4.2 Errors
-
-Since CAMARA Device Status API is based on REST design principles and blueprints, well defined HTTP status
-codes and families specified by community are followed [3].
-
-Details of HTTP based error/exception codes for the Device Status API are described in Section 4.2 of each API REST based method.
-Following table provides an overview of common error names, codes and messages applicable to Device Status API.
-
-| No | Error Name | Error Code | Error Message |
-|-----|-----------------------|------------|---------------------------------------------------------------|
-| 1 | Invalid port(s) | 400 | "Ports specification not valid" |
-| 2 | Invalid ueId | 400 | "Validation failed for parameter: ueId" |
-| 3 | Invalid port | 400 | "Validation failed for parameter: port" |
-| 4 | Unauthorized | 401 | "Un-authorized to invoke operation" |
-| 5 | Forbidden | 403 | "Forbidden to invoke operation" |
-| 6 | Not found | 404 | "The specified resource is not found" |
-| 7 | Internal server error | 500 | "Internal server error" |
-| 8 | Service unavailable | 503 | "Internal error due to required telco service unavailability" |
-| 9 | Timeout | 504 | "Request timeout exceeded." |
-
-### 4.3 Policies
-
-N/A
-
-### 4.4 Code Snippets
-
-| Snippet 1. Execute location verification |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| curl -X 'POST' `https://sample-base-url/device-status/v0/roaming`
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...."
-d '{
"ueId": {
"externalId": "exampleExternalId@domain.com",
"msisdn": "41793834315",
"ipv4Addr": "192.0. 2.146",
"ipv6Addr": "2001:db8:3333:4444:5555:6666:7777:8888"
},
"port": 5060 } |
-
-
-
-### 4.5 FAQ's
-
-(FAQs will be added in a later version of the documentation)
-
-### 4.6 Terms
-
-N/A
-
-### 4.7 Release Notes
-
-N/A
-
-## References
-
-[1] External Identifier format of the GPSI https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/UE-Identification.md#external-identifier-format-of-the-gpsi
-[2] Camara Commonalities : Authentication and Authorization Concept for Service
-APIs https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/Working/CAMARA-AuthN-AuthZ-Concept.md
-[3] HTTP Status codes spec https://restfulapi.net/http-status-codes
diff --git a/documentation/API_documentation/resources/DeviceStatus_Connectivity_diagram.png b/documentation/API_documentation/resources/DeviceStatus_Connectivity_diagram.png
deleted file mode 100644
index 0b95cc77..00000000
Binary files a/documentation/API_documentation/resources/DeviceStatus_Connectivity_diagram.png and /dev/null differ
diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/resources/README.MD
similarity index 100%
rename from documentation/API_documentation/README.MD
rename to documentation/API_documentation/resources/README.MD