-
Notifications
You must be signed in to change notification settings - Fork 10
/
rt-status.yml
118 lines (113 loc) · 4.06 KB
/
rt-status.yml
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
117
118
openapi: 3.0.3
components:
schemas:
StatusResult:
title: "Status"
allOf:
- type: object
required:
- Status
properties:
Status:
$ref: "#/components/schemas/Status"
- $ref: "./rt.yml#/components/schemas/ResultItem"
# $ref with description doesnt work right now, waiting for OAS 3.1 (comming soon)
# allOf should be used here to replace description from CheckResult
# see https://github.com/OAI/OpenAPI-Specification/issues/556#issuecomment-192007034
# but java codegen produce invalid code for allOf `int complete=null`
Status:
type: object
required:
- overallStatus
- optical
- detailsOptical
properties:
overallStatus:
description: "Overall checks status. Root status."
$ref: "./common.yml#/components/schemas/CheckResult"
optical:
description: "Overall optical checks combined status"
$ref: "./common.yml#/components/schemas/CheckResult"
portrait:
description: "Portrait comparison status"
$ref: "./common.yml#/components/schemas/CheckResult"
rfid:
description: "Overall RFID checks combined status"
$ref: "./common.yml#/components/schemas/CheckResult"
stopList:
description: "Stop list check status"
$ref: "./common.yml#/components/schemas/CheckResult"
detailsRFID:
description: "Details on performed RFID checks"
$ref: "#/components/schemas/detailsRFID"
detailsOptical:
description: "Details on performed optical checks"
$ref: "#/components/schemas/detailsOptical"
detailsOptical:
type: object
required:
- overallStatus
- docType
- expiry
- imageQA
- mrz
- pagesCount
- security
- text
properties:
overallStatus:
description: "Overall optical checks combined status"
$ref: "./common.yml#/components/schemas/CheckResult"
docType:
description: "Status of document type recognition"
$ref: "./common.yml#/components/schemas/CheckResult"
expiry:
description: "Status of document expiration"
$ref: "./common.yml#/components/schemas/CheckResult"
imageQA:
description: "Status of document image quality check"
$ref: "./common.yml#/components/schemas/CheckResult"
mrz:
description: "Status of document MRZ"
$ref: "./common.yml#/components/schemas/CheckResult"
pagesCount:
description: "Number of processed pages in the document"
type: integer
security:
description: "Authenticity verification status"
$ref: "./common.yml#/components/schemas/CheckResult"
text:
description: "Status of text fields analysis"
$ref: "./common.yml#/components/schemas/CheckResult"
detailsRFID:
type: object
required:
- overallStatus
- AA
- BAC
- CA
- PA
- PACE
- TA
properties:
overallStatus:
description: "Overall RFID checks combined status"
$ref: "./common.yml#/components/schemas/CheckResult"
AA:
description: "Active Authentication status"
$ref: "./common.yml#/components/schemas/CheckResult"
BAC:
description: "Basic Access Control (BAC) status"
$ref: "./common.yml#/components/schemas/CheckResult"
CA:
description: "Chip Authentication status"
$ref: "./common.yml#/components/schemas/CheckResult"
PA:
description: "Passive Authentication status"
$ref: "./common.yml#/components/schemas/CheckResult"
PACE:
description: "Password Authenticated Connection Establishment (PACE) status"
$ref: "./common.yml#/components/schemas/CheckResult"
TA:
description: "Terminal Authentication status"
$ref: "./common.yml#/components/schemas/CheckResult"