DevOps Requirements

This commit is contained in:
Brusk Hamarash 2021-10-03 19:21:16 +03:00
parent fa92ffc431
commit f5edaf45d4
No known key found for this signature in database
GPG Key ID: 509F705341F6504F

View File

@ -377,8 +377,42 @@ When using Kafka as a message broker, make sure that consumers of the same appli
#### Health Check #### Health Check
All web application are required to provide a `GET /health` endpoint that will return a `200` HTTP Response Code if:
1. The application was bootstrapped successful and
2. Necessary connections to different data sources can be established and
3. Connection to depending services can be established
If these conditions cannot be met, the endpoint must return a `503` HTTP Response Code.
#### Status #### Status
All web application are required to provide a `GET /status` endpoint with a similar response schema and a `200` HTTP Response Code:
```json
{
"name": {
"type": "string",
"description": "The application name"
},
"version": {
"type": "string",
"description": "The version of the application"
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "The start time when the application was successfully booted"
},
"host": {
"type": "string",
"description": "The name of the host machine on which the application is running"
}
}
```
## Software Application Specifications ## Software Application Specifications
### Authentication ### Authentication
@ -395,6 +429,8 @@ When using Kafka as a message broker, make sure that consumers of the same appli
### Pagination ### Pagination
### Idempotent Requests
## Accepted Technologies and Development Stacks ## Accepted Technologies and Development Stacks
### Software Development Stacks ### Software Development Stacks