Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
suthagar23 committed Jun 27, 2020
1 parent ef5c733 commit fa85234
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ Or, you can create configuration file for HealthAPI and attach it with the initi

| Property | Mandatory | Default value | Description |
| ------- | --- | ------------- | ----------- |
| apiPath | ☐ | "/status" | API path name |
| apiSecurity | ☐ | false | Secure health API with auth token |
| response| ☐ | { Object with all true } | Response object customization (You can avoid unwanted properties from health API response) |
| systemInformation | ☐ | { Object with all true } | Customize required system information properties |
| consumedServicesAsyncMode | ☐ | true | Consumed services health check method(Async or Sync based requests to endpoints) |
| consumedServices | ☐ | { } | Configuration of all the consumed services |
| apis | ☐ | { } | Configuration of all available APIs in the server |
| apiPath | - | "/status" | API path name |
| apiSecurity | - | false | Secure health API with auth token |
| response| - | { Object with all true } | Response object customization (You can avoid unwanted properties from health API response) |
| systemInformation | - | { Object with all true } | Customize required system information properties |
| consumedServicesAsyncMode | - | true | Consumed services health check method(Async or Sync based requests to endpoints) |
| consumedServices | - | { } | Configuration of all the consumed services |
| apis | - | { } | Configuration of all available APIs in the server |
| | |

### Custom configuration properties
Expand All @@ -93,7 +93,7 @@ Follow the steps to create your custom configuration file for health API.

| Property | Mandatory | Default value | Description |
| ------- | -------- | ------------- | ----------- |
| statusCodes | ☐ | true | Include status codes of health checks with response |
| statusCodes | - | true | Include status codes of health checks with response |
| | |

2. #### API Security configuration
Expand Down Expand Up @@ -143,11 +143,11 @@ Follow the steps to create your custom configuration file for health API.
| Property | Mandatory | Default value | Description |
| ------- | -------- | ------------- | ----------- |
| systemInformation | ☐ | { Object with all true } | Customize the system related information |
| ── common | ☐ | true | Retrieve common(OS, Uptime) information |
| ── cpu | ☐ | true | Retrieve CPU(Cores, Speeds) information |
| ── memory | ☐ | true | Retrieve memory(Total, Free) information |
| ── services | ☐ | undefined | Retrieve running service information from the server (Array of process names) |
| systemInformation | - | { Object with all true } | Customize the system related information |
| ── common | - | true | Retrieve common(OS, Uptime) information |
| ── cpu | - | true | Retrieve CPU(Cores, Speeds) information |
| ── memory | - | true | Retrieve memory(Total, Free) information |
| ── services | - | undefined | Retrieve running service information from the server (Array of process names) |
| | |
This is the example configuration to configure required system information,
Expand All @@ -168,10 +168,10 @@ Follow the steps to create your custom configuration file for health API.
| Property | Mandatory | Default value | Description |
| ------- | --------- | ------------- | ----------- |
| serviceName | ☐ | Unknown service name | Name to indicate the consumed service |
| serviceName | - | Unknown service name | Name to indicate the consumed service |
| healthCheckUrl | ✓ | - | Health check endpoint of the service |
| requestMethod | ☐ | GET | Request method of the health check URL (GET/POST/PUT/PATCH/HEAD/DELETE) |
| expectedResponseStatus | ☐ | 200 | Expected response status code from the health check endpoint |
| requestMethod | - | GET | Request method of the health check URL (GET/POST/PUT/PATCH/HEAD/DELETE) |
| expectedResponseStatus | - | 200 | Expected response status code from the health check endpoint |
| | |
5. #### API's configuration
Expand All @@ -180,11 +180,11 @@ Follow the steps to create your custom configuration file for health API.

| Property | Mandatory | Default value | Description |
| ------- | --------- | ------------- | ----------- |
| api | ☐ | Unknown API name | Name to indicate the API in the server |
| requestMethod | ☐ | GET | Request method of the API (GET/POST/PUT/PATCH/HEAD/DELETE) |
| dependsOn | ☐ | { } | Services configuration which this API depends on |
| api | - | Unknown API name | Name to indicate the API in the server |
| requestMethod | - | GET | Request method of the API (GET/POST/PUT/PATCH/HEAD/DELETE) |
| dependsOn | - | { } | Services configuration which this API depends on |
| ── serviceId | ✓ | - | ServiceId which mentioned in the consumed services section |
| ── isRequired | ☐ | true | Is this service required to serve this API (down this API if this service went down) |
| ── isRequired | - | true | Is this service required to serve this API (down this API if this service went down) |
| | |

6. #### Example custom configuration
Expand Down

0 comments on commit fa85234

Please sign in to comment.