1.0.10 • Published 1 year ago

hs-search-js v1.0.10

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

search_hs

SearchHs - JavaScript client for search_hs No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 search_hs --save

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 SearchHs = require('search_hs');
var defaultClient = SearchHs.ApiClient.instance;

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

var api = new SearchHs.GeneralApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v1ClearIndexDelete(callback);

Documentation for API Endpoints

All URIs are relative to ${BASE_URL}

ClassMethodHTTP requestDescription
SearchHs.GeneralApiv1ClearIndexDeleteDELETE /v1/clearIndex/clearIndex
SearchHs.GeneralApiv1DeletePostPOST /v1/delete/delete
SearchHs.GeneralApiv1IndexPostPOST /v1/index/index
SearchHs.GeneralApiv1SearchGetGET /v1/search/search (simple search)
SearchHs.GeneralApiv1SearchPostPOST /v1/search/search
SearchHs.GeneralApiv1StatsGetGET /v1/stats/stats

Documentation for Models

Documentation for Authorization

api_key

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

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago