-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Removed fixtures flagged by git-secrets for containing passwords/secrets Signed-off-by: Theo Truong <[email protected]>
- Loading branch information
Showing
10 changed files
with
444 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
/* | ||
* Copyright OpenSearch Contributors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* | ||
* The OpenSearch Contributors require contributions made to | ||
* this file be licensed under the Apache-2.0 license or a | ||
* compatible open source license. | ||
* | ||
*/ | ||
|
||
'use strict'; | ||
|
||
/** @namespace API-HTTP */ | ||
|
||
const { normalizeArguments, kConfigurationError } = require('../utils'); | ||
|
||
function HttpApi(transport, ConfigurationError) { | ||
this.transport = transport; | ||
this[kConfigurationError] = ConfigurationError; | ||
} | ||
|
||
HttpApi.prototype.request = function (method, params, options, callback) { | ||
[params, options, callback] = normalizeArguments(params, options, callback); | ||
if (Array.isArray(params.body)) { | ||
params.bulkBody = params.body; | ||
delete params.body; | ||
} | ||
options = options || {}; | ||
options.headers = params.headers || options.headers; | ||
return this.transport.request({ ...params, method }, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized CONNECT request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.connect = function (params, options, callback) { | ||
return this.request('CONNECT', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized DELETE request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.delete = function (params, options, callback) { | ||
return this.request('DELETE', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized GET request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.get = function (params, options, callback) { | ||
return this.request('GET', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized HEAD request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.head = function (params, options, callback) { | ||
return this.request('HEAD', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized OPTIONS request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.options = function (params, options, callback) { | ||
return this.request('OPTIONS', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized POST request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.post = function (params, options, callback) { | ||
return this.request('POST', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized PUT request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.put = function (params, options, callback) { | ||
return this.request('PUT', params, options, callback); | ||
}; | ||
|
||
/** | ||
* Make a customized TRACE request. | ||
* | ||
* @memberOf API-HTTP | ||
* | ||
* @param {Object} params | ||
* @param {Object} params.path - The URL of the request | ||
* @param {Object} [params.querystring] - The querystring parameters | ||
* @param {Object} [params.headers] - The request headers | ||
* @param {Object} [params.body] - The request body | ||
* | ||
* @param {Object} [options] - Options for {@link Transport#request} | ||
* @param {function} [callback] - Callback that handles errors and response | ||
* | ||
* @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} | ||
*/ | ||
HttpApi.prototype.trace = function (params, options, callback) { | ||
return this.request('TRACE', params, options, callback); | ||
}; | ||
|
||
module.exports = HttpApi; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Low-level API | ||
|
||
The OpenSearch client implements many high-level REST DSLs that invoke OpenSearch APIs. However, you may find yourself in a situation that requires you to invoke an API that is not supported by the client. In this case, you can use the low-level API to invoke any OpenSearch API. This guide shows you different ways to make custom API calls using the OpenSearch JS client. | ||
|
||
## Setup | ||
First, create a client instance with the following code to interact with an OpenSearch cluster with default security settings: | ||
|
||
```javascript | ||
const client = new Client({ | ||
ssl: { | ||
rejectUnauthorized: false, | ||
}, | ||
node: 'https://localhost:9200', | ||
auth: { | ||
username: 'admin', | ||
password: 'admin', | ||
}, | ||
}); | ||
``` | ||
|
||
## The http Namespace | ||
The `http` namespace comes with all functions representing HTTP methods like `http.get`, `http.post`, `http.put`, and `http.delete`. | ||
|
||
Let's create in index using `http.put`: | ||
```javascript | ||
await client.http.put({ | ||
path: '/movies', | ||
body: { | ||
mappings: { | ||
properties: { | ||
title: { type: 'text' }, | ||
director: { type: 'text' }, | ||
year: { type: 'integer' }, | ||
}, | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
Make sure that the index was created successfully using `http.head`: | ||
|
||
```javascript | ||
await client.http.head({ path: '/movies' }); | ||
``` | ||
|
||
Add two documents to the index using `http.post` and the bulk endpoint | ||
```javascript | ||
const body = [ | ||
{ index: { _index: index } }, | ||
{ title: 'The quick brown fox' }, | ||
{ index: { _index: index } }, | ||
{ title: 'The quick brown fox jumps over the lazy dog' }, | ||
]; | ||
await client.http.post({ path: `_bulk`, body }); | ||
``` | ||
|
||
Delete the index using `http.delete`: | ||
```javascript | ||
await client.http.delete({ path: '/movies' }); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.