Skip to content

Commit 28d992f

Browse files
Added descriptions /api/healthz & /api/readyz
1 parent e0c75e8 commit 28d992f

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

healthcheck.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ paths:
66
- $ref: "./common.yml#/components/parameters/x-request"
77
get:
88
summary: "Server healthcheck"
9+
description: "The `/api/healthz` endpoint performs a server health check, providing details such as the application name, license ID, serial number, validity, and product version. <br><br>Comprehensive information about service diagnostics is available on the [Monitoring page](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/monitoring/)."
910
operationId: healthz
1011
tags:
1112
- healthcheck
@@ -21,6 +22,7 @@ paths:
2122
- $ref: "./common.yml#/components/parameters/x-request"
2223
get:
2324
summary: "License healthcheck"
25+
description: "The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`)."
2426
operationId: readyz
2527
tags:
2628
- healthcheck

0 commit comments

Comments
 (0)