diff --git a/README.md b/README.md index 8767a3633..2fb1d944c 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,21 @@ BlueWave uptime monitoring application 2. [Installation (Server)](#server) 3. [Configuration(Server)](#config-server) 4. [Endpoints](#endpoints) + ###### Auth - POST [/api/v1/auth/register](#post-register) - POST [/api/v1/auth/login](#post-login) - POST [/api/v1/auth/user/{userId}](#post-auth-user-edit-id) + ###### Monitors - GET [/api/v1/monitors](#get-monitors) - GET [/api/v1/monitor/{id}](#get-monitor-id) - GET [/api/v1/monitors/user/{userId}](#get-monitors-user-userid) - POST [/api/v1/monitors](#post-monitors) - POST [/api/v1/monitors/delete/{monitorId}](#post-monitors-del-id) - POST [/api/v1/monitors/edit/{monitorId}](#post-monitors-edit-id) + ###### Checks + - POST [/api/v1/checks/{monitorId}](#post-checks) + - GET [/api/v1/checks/{monitorId}](#get-checks) + - POST [/api/v1/checks/delete/{monitorId}](#delete-checks) 5. [Error Handling](#error-handling) 6. [Contributors](#contributors) @@ -122,15 +128,15 @@ Example:
Check -| Name | Type | Notes | -| ----------- | --------- | ------------------------------------------------| -| monitorId | `string` | Unique ID for the monitor | -| status | `boolean` | Indicates the service is Up or Down | -| responseTime| `integer` | Indicates the response time of the service (ms) | -| statusCode | `integer` | Status Code returned from the service | -| message | `string` | Message returned from the service | -| updatedAt | `Date` | Last time the check was updated | -| CreatedAt | `Date` | When the check was created | +| Name | Type | Notes | +| ------------ | --------- | ----------------------------------------------- | +| monitorId | `string` | Unique ID for the monitor | +| status | `boolean` | Indicates the service is Up or Down | +| responseTime | `integer` | Indicates the response time of the service (ms) | +| statusCode | `integer` | Status Code returned from the service | +| message | `string` | Message returned from the service | +| updatedAt | `Date` | Last time the check was updated | +| CreatedAt | `Date` | When the check was created |
@@ -138,9 +144,9 @@ Example: Alert | Name | Type | Notes | -| ----------- | --------- | --------------------------------------------------| +| ----------------- | --------- | ------------------------------------------------- | | checkId | `string` | Unique ID for the check | -| status | `boolean` | Indicates the service is Up or Down | +| status | `boolean` | Indicates the service is Up or Down | | message | `string` | Message for the user about the down service | | notifiedStatus | `boolean` | Indicates whether the user is notified | | acknowledgeStatus | `boolean` | Indicates whether the user acknowledged the alert | @@ -148,8 +154,11 @@ Example: | CreatedAt | `Date` | When the alert was created | + --- +###### Auth +
POST /api/v1/auth/register @@ -201,8 +210,6 @@ curl --request POST \
---- -
POST /api/v1/auth/login @@ -250,8 +257,6 @@ curl --request POST \
---- -
POST/api/v1/auth/user/{userId} @@ -313,6 +318,8 @@ curl --request POST \ --- +###### Monitors +
GET /api/v1/monitors @@ -373,8 +380,6 @@ curl --request GET \
---- -
GET /api/v1/monitor/{id} @@ -421,8 +426,6 @@ curl --request GET \
---- -
GET /api/v1/monitors/user/{userId} @@ -483,8 +486,6 @@ curl --request GET \
---- -
POST/api/v1/monitors @@ -538,8 +539,6 @@ curl --request POST \
---- -
POST/api/v1/monitors/delete/{monitorId} @@ -575,8 +574,6 @@ curl --request POST \ ##
---- -
POST/api/v1/monitors/edit/{monitorId} @@ -636,6 +633,101 @@ curl --request POST \ --- +###### Checks + +
+POST/api/v1/checks/{monitorId} + +###### Method/Headers + +> | Method/Headers | Value | +> | -------------- | ----- | +> | Method | POST | + +###### Response Payload + +> | Type | Notes | +> | ---- | ------------------- | +> | None | No payload returned | + +###### Body + +##### Sample CURL request + +``` + +``` + +###### Sample Response + +```json + +``` + +
+ +
+GET/api/v1/checks/{monitorId} + +###### Method/Headers + +> | Method/Headers | Value | +> | -------------- | ----- | +> | Method | POST | + +###### Response Payload + +> | Type | Notes | +> | --------------- | ------------------------ | +> | `Array[Checks]` | Array of `Check` objects | + +##### Sample CURL request + +``` + +``` + +###### Sample Response + +```json + +``` + +
+ +
+POST/api/v1/checks/delete/{monitorId} + +###### Method/Headers + +> | Method/Headers | Value | +> | -------------- | ----- | +> | Method | POST | + +###### Response Payload + +> | Type | Notes | +> | ---- | ------------------- | +> | None | No payload returned | + +###### Body + +##### Sample CURL request + +``` + +``` + +###### Sample Response + +```json + +``` + +
+ +--- + ### Error handling {#error-handling} Errors are returned in a standard format: