-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathindex. 10BC0 yml
More file actions
95 lines (89 loc) · 3.6 KB
/
index.yml
File metadata and controls
95 lines (89 loc) · 3.6 KB
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
openapi: 3.0.4
info:
version: 8.1.0
title: Regula Document Reader Web API
x-logo:
url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg"
href: "https://regulaforensics.com"
description: |
Documents recognition as easy as reading two bytes.
# Clients:
* [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios
* [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android
* [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client
* [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
servers:
- url: https://api.regulaforensics.com/
description: Latest stable Regula Document Reader demo endpoint
- url: https://nightly-api.regulaforensics.com/
description: Nightly Regula document reader demo endpoint
- url: http://localhost:8080/
description: Local on-premise installation
paths:
/api/process:
$ref: "./p-process.yml#/paths/~1process"
/api/v2/transaction/{transactionId}/process:
$ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1process"
/api/v2/transaction/{transactionId}:
$ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D"
/api/v2/transaction/{transactionId}/results:
$ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1results"
/api/v2/transaction/{transactionId}/file:
$ref: "./p-transaction.yml#/paths/~1transaction~1%7BtransactionId%7D~1file"
/api/v2/tag/{tagId}:
$ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D"
/api/v2/tag/{tagId}/transactions:
$ref: "./p-transaction.yml#/paths/~1tag~1%7BtagId%7D~1transactions"
/api/ping:
$ref: "./p-ping.yml#/paths/~1ping"
/api/healthz:
$ref: "./p-healthcheck.yml#/paths/~1healthz"
/api/readyz:
$ref: "./p-healthcheck.yml#/paths/~1readyz"
/api/doclist:
$ref: "./p-doclist.yml#/paths/~1doclist"
tags:
- name: process
description: Everything about performing request and parsing response
- name: images_model
x-displayName: Images Model
description: |
<SchemaDefinition schemaRef="#/components/schemas/DocumentImage" />
- name: document_model
x-displayName: Document Model
description: |
**Chosen Document model:**
<SchemaDefinition schemaRef="#/components/schemas/ChosenDocumentType" />
**Candidates model:**
<SchemaDefinition schemaRef="#/components/schemas/DocumentTypesCandidates" />
x-tagGroups:
- name: Requests
tags:
- process
- transaction
- healthcheck
- resources
- name: Models
tags:
- images_model
- document_model
components:
schemas:
DocumentImage:
$ref: "./common.yml#/components/schemas/ImageData"
TransactionImage:
$ref: "./common.yml#/components/schemas/ImageTransactionData"
DocumentTypesCandidates:
$ref: "./rt-doc-type-old.yml#/components/schemas/DocumentTypesCandidatesList"
ChosenDocumentType:
$ref: "./rt-doc-type-old.yml#/components/schemas/OneCandidate"
RFIDPKDResourceType:
$ref: "./e-rfid-pkd-resourcetype.yml#/components/schemas/RFIDPKDResourceType"
ParsingErrorCodes:
$ref: "./e-parsing-error-codes.yml#/components/schemas/ParsingErrorCodes"
MDLDeviceEngagement:
$ref: "./common.yml#/components/schemas/MDLDeviceEngagement"
MDLDeviceRetrieval:
$ref: "./common.yml#/components/schemas/MDLDeviceRetrieval"
MDLServerRetrieval:
$ref: "./common.yml#/components/schemas/MDLServerRetrieval"