@tryiris/oculus

OpenCvImageProcessorApi - JavaScript client for @tryiris/oculus
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the Swagger Codegen project:

- API version: 0.1.0
- Package version: 0.1.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

$3

#### npm

To publish the library as a npm,
please follow the procedure in "Publishing npm packages".

Then install it via:

``shell
npm install @tryiris/oculus --save
`

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

`shell
npm install GIT_USER_ID/GIT_REPO_ID --save
`

$3

The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file):

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

$3

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

`javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
`

Getting Started

Please follow the installation instruction and execute the following JS code:

`javascript
var OpenCvImageProcessorApi = require('@tryiris/oculus');

var api = new OpenCvImageProcessorApi.DefaultApi()
var filename = null; // {Object}

var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getImageImageFilenameGet(filename, callback);
``

Documentation for API Endpoints

All URIs are relative to /

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
OpenCvImageProcessorApi.DefaultApi | getImageImageFilenameGet | GET /image/{filename} | Get Image
OpenCvImageProcessorApi.DefaultApi | processProcessPost | POST /process | Process

Documentation for Models

- OpenCvImageProcessorApi.BodyProcessProcessPost
- OpenCvImageProcessorApi.HTTPValidationError
- OpenCvImageProcessorApi.ProcessResponse
- OpenCvImageProcessorApi.ValidationError

Documentation for Authorization

All endpoints do not require authorization.