@image-intelligence/engine-api-specification v0.14.0
engine-api-specification
This package contains the API specifications for Ava Engine. The specifications are generated from protobuf files which define the API and compiled into JSON format.
Installation
npm install @image-intelligence/engine-api-specification
Usage
Import the NPM package and reference the relevant version you're after.
import ApiSpec from '@image-intelligence/engine-api-specification';
console.log('Versions:', Object.keys(ApiSpec));
console.log(JSON.stringify(ApiSpec['v1.0.0'], null, 2));
Development
- Clone project
git clone git@github.com:ImageIntelligence/ava-engine.git
Make edits to protobufs (
./protobuf
) as requiredTo test docs compilation, trigger build script from the root of the project. This will generate a JSON file in the
./docs/specs
directory.
Note: The version number used for the file name needs to be incremented manually for now. See ./docs/scripts/compile_docs.sh
sh ./docs/scripts/build.sh
Publishing
To publish, first commit the latest JSON file in the ./docs/specs
directory. This step is necessary so we can supply the relevant API specification corresponding to each Engine version we release.
Update ./docs/index.js
to include a reference to the latest version of the API spec.
Increment the version number in ./docs/package.json
then publish package as normal.
npm publish
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago