@ibutsu/client v1.0.0

@ibutsu/client

ibutsu - JavaScript client for @ibutsu/client A system to store and query test results This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.9.0
• Package version: 1.0.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 @ibutsu/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 @ibutsu/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 ibutsu = require('@ibutsu/client');


var api = new ibutsu.ArtifactApi()
var id = "id_example"; // {String} ID of artifact to delete
api.deleteArtifact(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Documentation for Models

• ibutsu.Artifact
• ibutsu.ArtifactList
• ibutsu.Group
• ibutsu.GroupList
• ibutsu.Health
• ibutsu.HealthInfo
• ibutsu.InlineObject
• ibutsu.InlineObject1
• ibutsu.InlineResponse200
• ibutsu.ModelImport
• ibutsu.Pagination
• ibutsu.Project
• ibutsu.ProjectList
• ibutsu.Report
• ibutsu.ReportList
• ibutsu.ReportParameters
• ibutsu.Result
• ibutsu.ResultList
• ibutsu.Run
• ibutsu.RunList
• ibutsu.WidgetConfig
• ibutsu.WidgetConfigList
• ibutsu.WidgetParam
• ibutsu.WidgetType
• ibutsu.WidgetTypeList

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header