Regula Face SDK OpenAPI definitions

Main GitHub repository

• Download OpenAPI specification

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

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.

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=facesdk-api-doc.html

Bundle scheme to single .json file

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