known-pose-client v1.1.10
known-pose-client
KnownPoseClient - JavaScript client for known-pose-client
Define and retrieve (accurate) semantic poses in a 2D environment. This version is a workaround for some not yet available features of the OpenAPI Specification v3.0 (e.g. anyOf
as a response type and adding a discriminator
for supporting polymorphism/composition). Therefore, ATM the sub-components BasicPose and InaccuratePose are reference objects inside their respective parent model.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.1.0
- Package version: 1.1.10
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install known-pose-client --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your known-pose-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
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):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
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:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var KnownPoseClient = require('known-pose-client');
var api = new KnownPoseClient.DevelopersApi()
var opts = {
'basicPose': new KnownPoseClient.BasicPose() // {BasicPose} Optional pose item to add
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.addAccuratePose(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://virtserver.swaggerhub.com/kw90/known-pose-api/1.1.0
Class | Method | HTTP request | Description |
---|---|---|---|
KnownPoseClient.DevelopersApi | addAccuratePose | POST /poses/accurate | adds an accurate pose item |
KnownPoseClient.DevelopersApi | addInaccuratePose | POST /poses | adds an inaccurate pose item |
KnownPoseClient.DevelopersApi | posesIdDelete | DELETE /poses/{id} | deletes a pose item |
KnownPoseClient.DevelopersApi | searchAccuratePose | GET /poses/accurate | searches accurate pose |
KnownPoseClient.DevelopersApi | searchPose | GET /poses | searches pose |
Documentation for Models
- KnownPoseClient.AccuratePose
- KnownPoseClient.AccuratePoseArray
- KnownPoseClient.BasicPose
- KnownPoseClient.InaccuratePose
- KnownPoseClient.InaccuratePoseArray
- KnownPoseClient.InlineResponse200
- KnownPoseClient.Orientation
- KnownPoseClient.Position
Documentation for Authorization
All endpoints do not require authorization.