{"id":20423547,"url":"https://github.com/regulaforensics/documentreader-web-openapi","last_synced_at":"2025-04-12T18:41:53.341Z","repository":{"id":42002306,"uuid":"279251951","full_name":"regulaforensics/DocumentReader-web-openapi","owner":"regulaforensics","description":"OpenAPI definitions of Regula Document Reader web application","archived":false,"fork":false,"pushed_at":"2025-04-07T09:15:45.000Z","size":1669,"stargazers_count":11,"open_issues_count":6,"forks_count":11,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-04-07T10:25:38.379Z","etag":null,"topics":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","openapi-definitions","passport","regula","regulaforensics","yml"],"latest_commit_sha":null,"homepage":"https://dev.regulaforensics.com/DocumentReader-web-openapi","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T09:06:14.000Z","updated_at":"2025-03-28T07:43:03.000Z","dependencies_parsed_at":"2024-07-22T13:26:48.774Z","dependency_job_id":"6ad8ae4c-6199-4060-af0e-eadd8b676305","html_url":"https://github.com/regulaforensics/DocumentReader-web-openapi","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/DocumentReader-web-openapi/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248617022,"owners_count":21134171,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","openapi-definitions","passport","regula","regulaforensics","yml"],"created_at":"2024-11-15T07:06:52.948Z","updated_at":"2025-04-12T18:41:53.335Z","avatar_url":"https://github.com/regulaforensics.png","language":null,"readme":"# Regula Document Reader OpenAPI definitions\n\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![release](https://img.shields.io/github/v/release/regulaforensics/DocumentReader-web-openapi?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi/releases)\n\n## Main GitHub repository\n\n* [https://github.com/regulaforensics/DocumentReader-web-openapi](https://github.com/regulaforensics/DocumentReader-web-openapi)\n\n## Clients\n\n* [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios\n* [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android\n* [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client\n* [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET \u0026 .NET Core\n\n## Structure\n\n* **index.yml** - definition entry point\n* **common.yml** - small enums and popular models\n* **rt.yml** - definitions import of all possible results types\n* **e - \\*.yml** - files with huge enum definitions\n* **rt - \\*.yml** - files describing results types\n* **p - \\*.yml** - files describing endpoints\n\n\n## Updating clients according to the current spec\n\nTo update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created.\n\n:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section.\n\n:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues.   \n\n:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder.\n\n:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict. \n\n\n##  Spec validation\n```\ndocker run --rm -v \"${PWD}:/local\" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml \n```\n\n## Building Redoc single page html documentation\n\nEdit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node\n\nEdit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator**\n\nThen run next command:\n```\nnpx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html\n```\n\n## Bundle scheme to single .json file\n```bash\nnpx openapi-generator-cli generate -i index.yml  -g openapi  --skip-validate-spec\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-openapi/lists"}