sinopia_server v3.0.3

sinopia_server

SinopiaServer - JavaScript client for sinopia_server Sinopia Server. Supports CRUD, following loosely LDP, on Sinopia resources. Top level requires special authorization for creating a group's graph (i.e. PCC, Stanford, etc.). This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.0.3
• Package version: 3.0.3
• Build package: io.swagger.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 sinopia_server --save

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

Finally, switch to the directory you want to use your sinopia_server from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('sinopia_server') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 SinopiaServer = require('sinopia_server');

var api = new SinopiaServer.DefaultApi()
api.healthCheck().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost

Documentation for Models

• SinopiaServer.Error
• SinopiaServer.ErrorResponse
• SinopiaServer.ErrorSource
• SinopiaServer.HealthCheckResponse
• SinopiaServer.LDPContainer
• SinopiaServer.Resource
• SinopiaServer.ResourceContext
• SinopiaServer.ResourceInfo
• SinopiaServer.SinopiaBasicContainer
• SinopiaServer.SinopiaBasicContainerContext
• SinopiaServer.SinopiaResource
• SinopiaServer.Variable

Documentation for Authorization

CognitoUser

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes: N/A