Regula Document Reader OpenAPI definitions

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

Scheme 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 Than run next command:

npx redoc-cli bundle 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"