FaceSDK-web-openapi/healthcheck.yml at develop · regulaforensics/FaceSDK-web-openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
openapi: 3.0.4

paths:
  /healthz:
    parameters:
      - $ref: "./common.yml#/components/parameters/x-request"
    get:
      summary: "Server healthcheck"
      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/)."
      operationId: healthz
      tags:
        - healthcheck
      responses:
        200:
          description: "Device info."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeviceInfo"

  /readyz:
    parameters:
      - $ref: "./common.yml#/components/parameters/x-request"
    get:
      summary: "License healthcheck"
      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`)."
      operationId: readyz
      tags:
        - healthcheck
      responses:
        200:
          description: "The license is valid."
        400:
          description: "The license is not valid."

components:
  schemas:
    DeviceInfo:
      title: "DeviceInfo"
      type: object
      required:
        - app
        - licenseId
        - licenseSerial
        - licenseValidUntil
        - version
      properties:
        app:
          description: Application name.
          type: string
        licenseId:
          description: Unique license identifier.
          type: string
          nullable: true
        licenseSerial:
          description: License serial number.
          type: string
          nullable: true
        licenseValidUntil:
          description: License validity date.
          type: string
          format: date-time
          nullable: true
        version:
          description: Product version.
          type: string
          nullable: true
      example:
        app: "Regula Face Recognition Web API"
        licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E"
        licenseSerial: "OL70786"
        licenseValidUntil: "9999-12-31T23:59:59Z"
        version: "7.5.297907.1721"