@mbari/data-catalog-javascript-client v0.0.7

@mbari/data-catalog-javascript-client

@MbariDataCatalogJavascriptClient - JavaScript client for @mbari/data-catalog-javascript-client This API is the interface to the MBARI data catalog software This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.7
• Package version: 0.0.7
• 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 @mbari/data-catalog-javascript-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 @mbari/data-catalog-javascript-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 @MbariDataCatalogJavascriptClient = require('@mbari/data-catalog-javascript-client');


var api = new @MbariDataCatalogJavascriptClient.DefaultApi()
var repo = "repo_example"; // {String} The name of the repository to query against (i.e. name of the elasticsearch index)
var opts = {
  'fileExtension': "fileExtension_example", // {String} The file name extension to search for
  'startIndex': 56, // {Number} Is the number of Resources to skip over before returning (pagination). Default is 0
  'itemsPerPage': 56, // {Number} Is the number of Resources to limit the return to. Default is 25
  'fieldsToReturn': "fieldsToReturn_example" // {String} A comma separated list of the fields the caller wants returned (options are uuid,content,data,file,locators,metadata,path,processing_messages)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResources(repo, opts, callback);

Documentation for API Endpoints

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

Documentation for Models

• @MbariDataCatalogJavascriptClient.Error
• @MbariDataCatalogJavascriptClient.ErrorErrors
• @MbariDataCatalogJavascriptClient.Resource
• @MbariDataCatalogJavascriptClient.ResourceFile
• @MbariDataCatalogJavascriptClient.Response
• @MbariDataCatalogJavascriptClient.ResponseData

Documentation for Authorization

All endpoints do not require authorization.