Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regulaforensics/documentreader-web-openapi
OpenAPI definitions of Regula Document Reader web application
https://github.com/regulaforensics/documentreader-web-openapi
barcode-reader document-reader document-recognition idcard mrz mrz-codes ocr openapi-definitions passport regula regulaforensics yml
Last synced: about 1 month ago
JSON representation
OpenAPI definitions of Regula Document Reader web application
- Host: GitHub
- URL: https://github.com/regulaforensics/documentreader-web-openapi
- Owner: regulaforensics
- License: other
- Created: 2020-07-13T09:06:14.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-13T07:40:26.000Z (about 1 month ago)
- Last Synced: 2024-11-13T08:29:15.686Z (about 1 month ago)
- Topics: barcode-reader, document-reader, document-recognition, idcard, mrz, mrz-codes, ocr, openapi-definitions, passport, regula, regulaforensics, yml
- Homepage: https://dev.regulaforensics.com/DocumentReader-web-openapi
- Size: 1 MB
- Stars: 9
- Watchers: 7
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Regula Document Reader OpenAPI definitions
[](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
[](https://github.com/regulaforensics/DocumentReader-web-openapi/releases)
## Main GitHub repository
* [https://github.com/regulaforensics/DocumentReader-web-openapi](https://github.com/regulaforensics/DocumentReader-web-openapi)
## 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
## Structure
* **index.yml** - definition entry point
* **common.yml** - small enums and popular models
* **rt.yml** - definitions import of all possible results types
* **e - \*.yml** - files with huge enum definitions
* **rt - \*.yml** - files describing results types
* **p - \*.yml** - files describing endpoints
## Updating clients according to the current spec
To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created.
:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section.
:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues.
:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder.
:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict.
## Spec validation
```
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml
```
## Building Redoc single page html documentation
Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node
Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator**
Then run next command:
```
npx redoc-cli bundle "$PWD/index.yml" --output document-reader-static-doc.html \
--options.maxDisplayedEnumValues=5 --options.theme.logo.gutter="20px" \
--options.theme.colors.primary.main="#8a53cb" --options.expandResponses="all" \
--options.expandSingleSchemaField --options.hideDownloadButton --options.jsonSampleExpandLevel="6"
```
## Bundle scheme to single .json file
```bash
npx openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec
```