DocumentReader-web-openapi/p-healthcheck.yml at develop · regulaforensics/DocumentReader-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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
openapi: 3.0.4
paths:
  /healthz:
    parameters:
      - $ref: "./common.yml#/components/parameters/x-request"
    get:
      summary: "Server health check"
      operationId: healthz
      tags:
        - healthcheck
      responses:
        200:
          description: "Device info."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Healthcheck"
  /readyz:
    parameters:
      - $ref: "./common.yml#/components/parameters/x-request"
    get:
      summary: "License health check"
      operationId: readyz
      tags:
        - healthcheck
      responses:
        200:
          description: "The license is valid."
        400:
          description: "The license is not valid."

components:
  schemas:
    Healthcheck:
      title: "Healthcheck"
      type: object
      required:
        - app
        - licenseId
        - licenseType
        - licenseSerial
        - licenseValidUntil
        - scenarios
        - version
      properties:
        app:
          description: Application name.
          type: string
        licenseId:
          description: Unique license identifier.
          type: string
          nullable: true
        licenseType:
          description: License type.
          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
        scenarios:
          description: List of supported scenarios.
          type: array
          nullable: true
          items:
            type: string
        version:
          description: Product version.
          type: string
          nullable: true
        metadata:
          type: object
          additionalProperties: true
        documentsDatabase:
          description: Database information.
          type: object
          required:
            - id
            - version
            - exportDate
            - description
          properties:
            id:
              description: Database identifier.
              type: string
              nullable: true
            version:
              description: Database version.
              type: string
              nullable: true
            exportDate:
              description: Date of database creation.
              type: string
              nullable: true
            description:
              description: Description of the database contents, such as the list of supported countries and documents.
              type: string
              nullable: true
      example:
        app: "Regula Document Reader Web API"
        licenseId: "4D43A2AF-E321-496C-9A4E-5A8F3D26DF0E"
        licenseType: "Transactional"
        licenseSerial: "OL70786"
        licenseValidUntil: "9999-12-31T23:59:59Z"
        scenarios: ["Mrz", "Barcode", "Locate"]
        version: "7.5.297907.1721"
        documentsDatabase:
          id: "FullAuth"
          version: "800111"
          exportDate: "2024-11-11"
          description: "FullAuth: All documents"