npm package: @mbari/data-catalog-api
Description: This_API_is_the_interface_to_the_MBARI_data_catalog_software
Latest version: 0.0.5
Deprecated: This module was renamed to @mbari/data-catalog-javascript-client

# @mbari/data-catalog-api

@MbariDataCatalogApi - JavaScript client for @mbari/data-catalog-api
This API is the interface to the MBARI data catalog software
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.5
- Package version: 0.0.5
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @mbari/data-catalog-api --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your @mbari/data-catalog-api from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var @MbariDataCatalogApi = require('@mbari/data-catalog-api');


var api = new @MbariDataCatalogApi.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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*@MbariDataCatalogApi.DefaultApi* | [**getResources**](docs/DefaultApi.md#getResources) | **GET** /resources | Search for Resources


## Documentation for Models

 - [@MbariDataCatalogApi.Error](docs/Error.md)
 - [@MbariDataCatalogApi.ErrorErrors](docs/ErrorErrors.md)
 - [@MbariDataCatalogApi.Resource](docs/Resource.md)
 - [@MbariDataCatalogApi.ResourceFile](docs/ResourceFile.md)
 - [@MbariDataCatalogApi.Response](docs/Response.md)
 - [@MbariDataCatalogApi.ResponseData](docs/ResponseData.md)


## Documentation for Authorization

All endpoints do not require authorization.