Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

regulaforensics/DocumentReader-web-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

627 Commits

Repository files navigation

Regula Document Reader OpenAPI definitions

documentation release

Main GitHub repository

Clients

  • JavaScript client for the browser and node.js based on axios
  • Java client compatible with jvm and android
  • Python 3.5+ client
  • C# 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

When changes are added, the update clients action is automatically triggered. For each client PR with changes will be created.

⚠️ NOTE: Before working with a client, read dev.md which is available in each client repository.

⚠️ NOTE: Do not edit generated code. Create wrappers, decorators, etc. in ext folder.

πŸ’‘ All clients have RawResultItem and AuthenticityCheckResultItem containers that are used for deserialization oneOf schemas. These containers are 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

npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html

Bundle scheme to single .json file

npx @openapitools/openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /