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/FaceSDK-web-openapi

Repository files navigation

Regula Face SDK OpenAPI definitions

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

Generate html page

npx redoc-cli build "$PWD/index.yml" --output facesdk-api-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"

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.

⚠️ NOTE: Static typed clients, such as Java or C#, require adding all new enums to update-models.sh ENUM_MAPPINGS section.

⚠️ NOTE: For some clients generator produces not-valid client code. See update-models.sh for ad-hocks fixing generator issues.

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

About

OpenAPI definitions of Regula Face SDK web API

Topics

Resources

Stars

Watchers

Forks

Contributors 15

AltStyle によって変換されたページ (->オリジナル) /