@fermyon/hippo-openapi

v0.4.0

Published

2 years ago

JS API client generated by OpenAPI Generator

Downloads

0High
0Medium
0Low

hippo_web

HippoWeb - JavaScript client for hippo_web No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 0.4.0
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 hippo_web --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 hippo_web 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/deislabs/deislabs/hippo-openapi then install it via:

    npm install deislabs/deislabs/hippo-openapi --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 HippoWeb = require('hippo_web');

var defaultClient = HippoWeb.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new HippoWeb.AccountApi()
var opts = {
  'createTokenCommand': new HippoWeb.CreateTokenCommand() // {CreateTokenCommand}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiAccountCreatetokenPost(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- HippoWeb.AccountApi | apiAccountCreatetokenPost | POST /api/account/createtoken | HippoWeb.AccountApi | apiAccountPost | POST /api/account | HippoWeb.AppApi | apiAppExportGet | GET /api/app/export | HippoWeb.AppApi | apiAppGet | GET /api/app | HippoWeb.AppApi | apiAppIdDelete | DELETE /api/app/{id} | HippoWeb.AppApi | apiAppPost | POST /api/app | HippoWeb.CertificateApi | apiCertificateExportGet | GET /api/certificate/export | HippoWeb.CertificateApi | apiCertificateGet | GET /api/certificate | HippoWeb.CertificateApi | apiCertificateIdDelete | DELETE /api/certificate/{id} | HippoWeb.CertificateApi | apiCertificatePost | POST /api/certificate | HippoWeb.ChannelApi | apiChannelExportGet | GET /api/channel/export | HippoWeb.ChannelApi | apiChannelGet | GET /api/channel | HippoWeb.ChannelApi | apiChannelIdDelete | DELETE /api/channel/{id} | HippoWeb.ChannelApi | apiChannelPost | POST /api/channel | HippoWeb.EnvironmentVariableApi | apiEnvironmentvariableExportGet | GET /api/environmentvariable/export | HippoWeb.EnvironmentVariableApi | apiEnvironmentvariableGet | GET /api/environmentvariable | HippoWeb.EnvironmentVariableApi | apiEnvironmentvariableIdDelete | DELETE /api/environmentvariable/{id} | HippoWeb.EnvironmentVariableApi | apiEnvironmentvariablePost | POST /api/environmentvariable | HippoWeb.RevisionApi | apiRevisionExportGet | GET /api/revision/export | HippoWeb.RevisionApi | apiRevisionGet | GET /api/revision | HippoWeb.RevisionApi | apiRevisionIdDelete | DELETE /api/revision/{id} | HippoWeb.RevisionApi | apiRevisionPost | POST /api/revision |

Documentation for Models

Documentation for Authorization

Bearer

Type: API key
API key parameter name: Authorization
Location: HTTP header