Added point in time APIs #348

ajygupta · 2022-12-20T07:44:37Z

Description

Added point in time APIs

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Arpit-Bandejiya · 2022-12-20T11:02:11Z

Should we add the documentation for using these APIs as well?

api/api/get_all_pits.js

nhtruong · 2022-12-20T19:18:56Z

Should we add the documentation for using these APIs as well?

Yes please. And don't forget to update the changelog!
Thank you for your contribution :D

ananzh · 2022-12-24T07:35:15Z

Hey @ajygupta I see there are 8 commits in this PR and 7 of them are old commits that already merged into main. Could you pull the latest main and rebase this PR? It will help others to view the added context from PIT API. Thanks.

Signed-off-by: Ajay Gupta <[email protected]>

api/api/create_pit.js

api/types.d.ts

ananzh · 2023-01-04T19:10:54Z

USER_GUIDE.md

+```javascript
+console.log('Deleting a PIT:');
+
+var response = await client.deletePit({


Could you add a comment here for how a user can get this pit_id ?

I'm not sure if I understand this completely. A particular point in time (PIT) is denoted by a pit_id. It's like a particular index is denoted by an index_name

How do we get a pit_id?

We get it when we create a point in time.

ananzh · 2023-01-04T19:13:17Z

api/api/create_pit.js

@@ -0,0 +1,86 @@
+/*


I think the license header for new added file should be

/* * Copyright OpenSearch Contributors * SPDX-License-Identifier: Apache-2.0 */

Updated. Thanks

@ananzh I updated as per the suggestion but the license check fails. Do we need to fix that?

@ajygupta

I think currently opensearch-js is using this header here. Pls double check.

/* * 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. * */

Well, we have updated this header to the one I mentioned in the comment.
Some discussions as reference
opensearch-project/opensearch-build#2666 (comment)
opensearch-project/alerting#136 (comment)

However, it is not updated in opensearch-js and the header check is still checking the old one. To unblock you, I would suggest to use the old one and I will submit an issue or PR to update the header. Sorry for the inconvenience.

api/api/create_pit.js

api/api/delete_all_pits.js

api/api/delete_pit.js

ananzh · 2023-01-04T19:39:31Z

api/api/create_pit.js

+
+'use strict';
+
+/* eslint camelcase: 0 */


What is the meaning of this two lines of eslint rules? could you provide some explains for adding these two lines? for example, is this eslint camelcase: 0 same as esline-disable camelcase which disable camelcase check for a file?

This is just to keep it consistent with the other files, so that once we fix the auto-generation logic, we won't see any changes in these files.

Well I think I don't understand these two lines. Do you understand why we use these two lines?

AFAIK eslint camelcase: 0 and eslint no-unused-vars: 0 are for disabling camelcase check and unused variables check respectively.

api/api/create_pit.js

api/api/delete_all_pits.js

api/api/delete_pit.js

api/api/get_all_pits.js

ananzh

LGTM. Thank you.

wbeckler · 2023-01-12T14:03:36Z

@nhtruong can you take a look at this PR? It's been merged, but it wouldn't hurt to have another look since it was only reviewed by one maintainer.

bharath-techie · 2023-01-16T14:08:24Z

@kavilla can you please take a look and approve for us to release this change

kavilla · 2023-01-23T20:51:57Z

I would bump the version of this package to 2.2 for this feature

kavilla · 2023-01-23T20:54:17Z

Which version is this feature change compatible with?

If it's only works on an unreleased version of OpenSearch I would update this file:

https://github.com/opensearch-project/opensearch-js/blob/main/COMPATIBILITY.md

Like bump the version of this package to reflect the changes in case folks pull down a patch update and try to use these APIs and not get a failure.

Added point in time APIs Signed-off-by: Ajay Gupta <[email protected]> Signed-off-by: Ajay Gupta <[email protected]> Co-authored-by: Ajay Gupta <[email protected]>

* Manually sync CHANGELOG.md, release-drafter.yml, RELEASING.md, and USER_GUIDE.md * Version Bump: 2.3.0 (opensearch-project#546) * Upgrade and secure the backport workflow (opensearch-project#547) * Add serialization and deserialization of numerals larger than `Number.MAX_SAFE_INTEGER` (opensearch-project#544) * Add upgrading NPM to all workflows running older Node.js versions (opensearch-project#545) * Bump @types/node from 20.1.4 to 20.2.5 (opensearch-project#528) * Bump @aws-sdk/types from 3.329.0 to 3.341.0 (opensearch-project#527) * Bump ora from 6.3.0 to 6.3.1 (opensearch-project#524) * Bump node-fetch from 3.2.10 to 3.3.1 (opensearch-project#526) * Bump eslint from 8.39.0 to 8.41.0 (opensearch-project#525) * Bump @types/node from 18.16.0 to 20.1.4 (opensearch-project#518) * Bump xmlbuilder2 from 3.1.0 to 3.1.1 (opensearch-project#519) * Bump semver from 7.3.8 to 7.5.1 (opensearch-project#520) * Added timursaurus to MAINTAINERS.md (opensearch-project#517) * Bump @aws-sdk/types from 3.257.0 to 3.329.0 (opensearch-project#516) * Bump @babel/eslint-parser from 7.21.3 to 7.21.8 (opensearch-project#513) * Bump simple-git from 3.17.0 to 3.18.0 (opensearch-project#512) * Bump xmlbuilder2 from 3.0.2 to 3.1.0 (opensearch-project#503) * Bump eslint from 8.38.0 to 8.39.0 (opensearch-project#504) * Bump @types/node from 18.15.11 to 18.16.0 (opensearch-project#499) * Bump ora from 6.1.2 to 6.3.0 (opensearch-project#500) * Bump prettier from 2.8.7 to 2.8.8 (opensearch-project#501) * Implemented Docker Image caching for `integration-unreleased` workflow (opensearch-project#498) * [Bug] Fixed bundler.yml (opensearch-project#497) * Bumped Version 2.2.1 In preparation for release (opensearch-project#495) * Bump @types/node from 18.15.10 to 18.15.11 (opensearch-project#493) * Bump eslint from 8.33.0 to 8.38.0 (opensearch-project#494) * Bump rimraf from 4.4.0 to 5.0.0 (opensearch-project#492) * [CCI] feat: add missing createConnection type (opensearch-project#490) * Add Search guide (opensearch-project#489) * Create search guide (opensearch-project#488) * [CCI] Create advanced index actions guide (opensearch-project#483) * [CCI] Connection `request` method callback (opensearch-project#478) * feat: NotCompatibleError (opensearch-project#484) * Bump @babel/eslint-parser from 7.19.1 to 7.21.3 (opensearch-project#486) * Bump jsdoc from 4.0.0 to 4.0.2 (opensearch-project#485) * Bump prettier from 2.8.4 to 2.8.7 (opensearch-project#487) * Create document lifecycle guide (opensearch-project#481) * Create index lifecycle guide (opensearch-project#482) * Create bulk guide (opensearch-project#480) * [CCI] Create index_template guide (opensearch-project#479) * Bump split2 from 4.1.0 to 4.2.0 (opensearch-project#467) * Bump deepmerge from 4.3.0 to 4.3.1 (opensearch-project#468) * Bump @types/node from 18.15.3 to 18.15.10 (opensearch-project#462) * Bump eslint-config-prettier from 8.6.0 to 8.8.0 (opensearch-project#463) * [CCI] Update developerGuide regarding yarn troubleshoot steps (opensearch-project#456) * [CCI] Bump caniuse-lite from 1.0.30001249 to 1.0.30001469 (opensearch-project#459) * added the solution for the possible error during yarn installation on Windows OS (opensearch-project#453) * Fixed deprecation warnings (opensearch-project#446) * [CCI] Don't run tests on PRs with doc changes only (opensearch-project#441) * [CCI] Add pull request template (opensearch-project#440) * Bump @types/node from 17.0.45 to 18.15.3 (opensearch-project#448) * Bump simple-git from 3.16.0 to 3.17.0 (opensearch-project#447) * [CCI] Update Developer Guide (opensearch-project#436) * [CCI] Remove waitCluster in Integration Tests (opensearch-project#423) * Bump tsd from 0.25.0 to 0.27.0 (opensearch-project#431) * Bump rimraf from 4.1.1 to 4.4.0 (opensearch-project#432) * [CCI] doc: fix grammar (opensearch-project#427) * Fix deprecated folder mapping "./" in the "exports" field (opensearch-project#416) * [CCI] fix: pass required `data` argument to SerializationError class (opensearch-project#419) * Bump tap from 16.3.0 to 16.3.4 (opensearch-project#413) * [CCI] Refactor: Remove unnecessary `data` argument when invoking `OpenSearchClientError` (opensearch-project#421) * Bump deepmerge from 4.2.2 to 4.3.0 (opensearch-project#414) * Updated Maintainers list and changelogs (opensearch-project#409) * Downgraded @types/node to 17 from 18 due to breaking changes. (opensearch-project#405) * Bump aws4 from 1.11.0 to 1.12.0 (opensearch-project#406) * Bump prettier from 2.8.3 to 2.8.4 (opensearch-project#407) * Bump minimist from 1.2.7 to 1.2.8 (opensearch-project#388) * Bump tsd from 0.24.1 to 0.25.0 (opensearch-project#389) * Add missing types for AwsSigv4SignerOptions.service (opensearch-project#377) * Created untriaged issue workflow. (opensearch-project#386) Daniel (dB.) Doubrovkine* 2/14/23, 12:14 PM * Bump dezalgo from 1.0.3 to 1.0.4 (opensearch-project#383) * Bump simple-statistics from 7.7.0 to 7.8.3 (opensearch-project#384) * Bump eslint from 8.32.0 to 8.33.0 (opensearch-project#379) * Allow fields in BulkOperation to be optional (opensearch-project#378) * Bump @types/node from 18.11.18 to 18.11.19 (opensearch-project#380) * Bump ora from 5.4.1 to 6.1.2 (opensearch-project#376) * Bump @aws-sdk/types from 3.226.0 to 3.257.0 (opensearch-project#375) * Bump secure-json-parse from 2.4.0 to 2.7.0 (opensearch-project#369) * Bump simple-git from 3.15.1 to 3.16.0 (opensearch-project#373) * Updated user guide to include Amazon OpenSearch Serverless (opensearch-project#372) * Added Support for AOSS (opensearch-project#366) * Bump rimraf from 3.0.2 to 4.1.1 (opensearch-project#370) * Bump eslint-config-prettier from 8.5.0 to 8.6.0 (opensearch-project#368) * Bump hpagent from 0.1.2 to 1.2.0 (opensearch-project#361) * Bump eslint from 8.30.0 to 8.32.0 (opensearch-project#362) * Fixed missing namespace for API-PIT endpoints (opensearch-project#364) * Bump prettier from 2.7.1 to 2.8.3 (opensearch-project#363) * Ensure Dependabot PR workflow retriggers on label change (opensearch-project#360) * Added point in time APIs (opensearch-project#348) * Bump @types/node from 15.14.7 to 18.11.18 (opensearch-project#353) * Bump split2 from 3.2.2 to 4.1.0 (opensearch-project#354) * Bump json5 from 2.2.0 to 2.2.3 (opensearch-project#359) * Bump @aws-sdk/types from 3.190.0 to 3.226.0 (opensearch-project#355) * Updated MAINTAINERS.md to match recommended opensearch-project format. (opensearch-project#358) Daniel (dB.) Doubrovkine* 1/6/23, 8:36 AM * Bump minimist from 1.2.6 to 1.2.7 (opensearch-project#350) * Bump eslint from 7.32.0 to 8.30.0 (opensearch-project#346) * Bump eslint-plugin-prettier from 4.0.0 to 4.2.1 (opensearch-project#351) * Removed test artifacts from gh_pages workflow (opensearch-project#347) * Bump minimatch from 3.0.4 to 3.1.2 (opensearch-project#345) * Bump xmlbuilder2 from 2.4.1 to 3.0.2 (opensearch-project#321) * Implement JSDOC (opensearch-project#337) * Added skip-changelog label (opensearch-project#339) * Bumps simple-git from 3.4.0 to 3.15.0 (opensearch-project#341) * [FEATURE] Allow overriding the aws service identifier in AwsSigv4Signer (opensearch-project#333) * Add release details and bump the jenkins lib version (opensearch-project#319) * Bump Version from 2.1.0 to 2.1.1 (opensearch-project#318) * Bump semver from 7.3.7 to 7.3.8 (opensearch-project#313) * Add release workflows (opensearch-project#317) * issue opensearch-project#291 mutability of headers (opensearch-project#311) * Bump tsd from 0.22.0 to 0.24.1 (opensearch-project#312) * Add changelog and changelog verifier (opensearch-project#306) * Bump prettier from 2.6.2 to 2.7.1 (opensearch-project#310) * Bump @aws-sdk/types from 3.160.0 to 3.190.0 (opensearch-project#309) * Bump node-fetch from 2.6.7 to 3.2.10 (opensearch-project#281) * Update Maintainers List (opensearch-project#308) * Implemented Retry for OpenSearch Container (opensearch-project#304) * Feature/add default credentials provider (opensearch-project#295) * Fix new line problem between diffs (opensearch-project#302) * Removed Unused Variables (opensearch-project#301) * fix awssigv4signer.test.js tests not running (opensearch-project#294) * fix: support TS resolution for .mjs (opensearch-project#296) * Add AwsSigV4 signing functionality (opensearch-project#279) * Fix opensearch-project#253 Cannot read property 'then' of null in Transport.js issue. (opensearch-project#283) * Bump simple-git from 3.5.0 to 3.13.0 (opensearch-project#286) * Bump semver from 7.3.5 to 7.3.7 (opensearch-project#280) * Adds bulk example to README (opensearch-project#277) * Adding Dependabot configuration (opensearch-project#278) * Removing OpenDistro integration tests (opensearch-project#271) * Upgrade dependencies (opensearch-project#272) * fix: add missing memory circuit breaker options (opensearch-project#266) * feat: allow `doc` overwrite in `onDocument` (opensearch-project#263) * Adding link checker workflow (opensearch-project#262) * Using standardized templates from .github (opensearch-project#249) * Adding new OpenSearch versions and updating compatibility matrix (opensearch-project#257) Signed-off-by: Miki <[email protected]>

ajygupta requested review from ananzh, kavilla, seanneumann, dblock, VachaShah and nhtruong as code owners December 20, 2022 07:44

ajygupta force-pushed the pit branch from f572eb9 to 7bb8681 Compare December 20, 2022 08:58

bharath-techie reviewed Dec 20, 2022

View reviewed changes

api/api/get_all_pits.js Show resolved Hide resolved

Added point in time APIs

131f250

Signed-off-by: Ajay Gupta <[email protected]>

ajygupta force-pushed the pit branch from aa5c3f9 to 131f250 Compare December 26, 2022 13:30

bharath-techie reviewed Dec 27, 2022

View reviewed changes

api/api/create_pit.js Show resolved Hide resolved

bharath-techie reviewed Dec 27, 2022

View reviewed changes

api/types.d.ts Show resolved Hide resolved

ananzh requested changes Jan 4, 2023

View reviewed changes

ajygupta force-pushed the pit branch from 65e5cee to 131f250 Compare January 10, 2023 04:23

ananzh approved these changes Jan 10, 2023

View reviewed changes

ananzh merged commit b718526 into opensearch-project:main Jan 11, 2023

ajygupta deleted the pit branch January 23, 2023 06:02

ajygupta restored the pit branch January 23, 2023 06:02

AMoo-Miki mentioned this pull request Jul 12, 2023

Manual master cherrypick into 2.x #550

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added point in time APIs #348

Added point in time APIs #348

ajygupta commented Dec 20, 2022

Arpit-Bandejiya commented Dec 20, 2022

nhtruong commented Dec 20, 2022

ananzh commented Dec 24, 2022 •

edited

Loading

ananzh Jan 4, 2023

ajygupta Jan 5, 2023 •

edited

Loading

ananzh Jan 9, 2023

ajygupta Jan 10, 2023

ananzh Jan 4, 2023

ajygupta Jan 5, 2023

ajygupta Jan 6, 2023

ananzh Jan 9, 2023 •

edited

Loading

ananzh Jan 4, 2023

ajygupta Jan 5, 2023

ananzh Jan 9, 2023

ajygupta Jan 10, 2023

ananzh left a comment

wbeckler commented Jan 12, 2023

bharath-techie commented Jan 16, 2023

kavilla commented Jan 23, 2023

kavilla commented Jan 23, 2023

Added point in time APIs #348

Added point in time APIs #348

Conversation

ajygupta commented Dec 20, 2022

Description

Issues Resolved

Arpit-Bandejiya commented Dec 20, 2022

nhtruong commented Dec 20, 2022

ananzh commented Dec 24, 2022 • edited Loading

Choose a reason for hiding this comment

ajygupta Jan 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ananzh Jan 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ananzh left a comment

Choose a reason for hiding this comment

wbeckler commented Jan 12, 2023

bharath-techie commented Jan 16, 2023

kavilla commented Jan 23, 2023

kavilla commented Jan 23, 2023

ananzh commented Dec 24, 2022 •

edited

Loading

ajygupta Jan 5, 2023 •

edited

Loading

ananzh Jan 9, 2023 •

edited

Loading