zinc-client
Advanced tools
Readme
ZincClient - JavaScript client for zinc-client Zinc Search engine API documents https://docs.zincsearch.com This SDK is automatically generated by the OpenAPI Generator project:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install zinc-client --save
Finally, you need to build the module:
npm run build
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 zinc-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/zinclabs/client-js then install it via:
npm install zinclabs/client-js --save
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.
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
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var ZincClient = require('zinc-client');
var defaultClient = ZincClient.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new ZincClient.Default()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.healthz(callback);
All URIs are relative to http://localhost:4080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ZincClient.Default | healthz | GET /healthz | Get healthz |
| ZincClient.Default | version | GET /version | Get version |
| ZincClient.Document | bulk | POST /api/_bulk | Bulk documents |
| ZincClient.Document | delete | DELETE /api/{index}/_doc/{id} | Delete document |
| ZincClient.Document | esBulk | POST /es/_bulk | ES bulk documents |
| ZincClient.Document | index | POST /api/{index}/_doc | Create or update document |
| ZincClient.Document | indexWithID | PUT /api/{index}/_doc/{id} | Create or update document with id |
| ZincClient.Document | update | POST /api/{index}/_update/{id} | Update document with id |
| ZincClient.Index | analyze | POST /api/_analyze | Analyze |
| ZincClient.Index | analyzeIndex | POST /api/{index}/_analyze | Analyze |
| ZincClient.Index | delete | DELETE /api/index/{index} | Delete index |
| ZincClient.Index | create | POST /api/index | Create index |
| ZincClient.Index | createTemplate | POST /es/_index_template | Create update index template |
| ZincClient.Index | deleteTemplate | DELETE /es/_index_template/{name} | Delete template |
| ZincClient.Index | getMapping | GET /api/{index}/_mapping | Get index mappings |
| ZincClient.Index | getSettings | GET /api/{index}/_settings | Get index settings |
| ZincClient.Index | getTemplate | GET /es/_index_template/{name} | Get index template |
| ZincClient.Index | list | GET /api/index | List indexes |
| ZincClient.Index | listTemplates | GET /es/_index_template | List index teplates |
| ZincClient.Index | refresh | POST /api/index/{index}/refresh | Resfresh index |
| ZincClient.Index | setMapping | PUT /api/{index}/_mapping | Set index mappings |
| ZincClient.Index | setSettings | PUT /api/{index}/_settings | Set index Settings |
| ZincClient.Index | updateTemplate | PUT /es/_index_template/{name} | Create update index template |
| ZincClient.Search | mSearch | POST /es/_msearch | Search V2 MultipleSearch for compatible ES |
| ZincClient.Search | search | POST /es/{index}/_search | Search V2 DSL for compatible ES |
| ZincClient.Search | searchV1 | POST /api/{index}/_search | Search V1 |
| ZincClient.User | delete | DELETE /api/user/{id} | Delete user |
| ZincClient.User | create | POST /api/user | Create user |
| ZincClient.User | list | GET /api/user | List user |
| ZincClient.User | login | POST /api/login | Login |
| ZincClient.User | update | PUT /api/user | Update user |
FAQs
Zinc Search engine API documents
We found that zinc-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.