Implement JSDOC #337

nhtruong · 2022-11-22T21:22:24Z

Description

This change added jsdoc and a workflow to generate and publish documentation to gh_pages. It also includes documentation for Transport#request and api/bulk. More documentation will also be added incrementally in the subsequent PRs.

Issues Resolved

closes #335

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.

harshavamsi · 2022-11-22T22:11:19Z

@nhtruong is there a link to the docs on your fork?

nhtruong · 2022-11-22T22:15:58Z

@harshavamsi Yes here it is: https://nhtruong.github.io/opensearch-js/2.1/
This was created by the workflow included in this PR.

nhtruong · 2022-11-29T23:09:59Z

Added docs for all CAT APIs
README.md is used as the homepage for now (It's not great but it's a start)

dblock

I like it but I'd like to nitpick a little.

dblock · 2022-11-30T16:05:54Z

CHANGELOG.md

@@ -5,6 +5,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Add release details to releasing.md ([319](https://github.com/opensearch-project/opensearch-js/pull/319))
 - Allow overriding the aws service identifier in AwsSigv4Signer ([333](https://github.com/opensearch-project/opensearch-js/pull/333))
+- jsdoc for documentation generation ([#335](https://github.com/opensearch-project/opensearch-js/issues/335))


Added jsdoc ...

dblock · 2022-11-30T16:06:06Z

CHANGELOG.md

@@ -5,6 +5,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Add release details to releasing.md ([319](https://github.com/opensearch-project/opensearch-js/pull/319))
 - Allow overriding the aws service identifier in AwsSigv4Signer ([333](https://github.com/opensearch-project/opensearch-js/pull/333))
+- jsdoc for documentation generation ([#335](https://github.com/opensearch-project/opensearch-js/issues/335))
+- Documentation for Transport#request ([#335](https://github.com/opensearch-project/opensearch-js/issues/335))


Documented ...

dblock · 2022-11-30T16:06:41Z

api/api/cat.js

@@ -92,16 +95,34 @@ function CatApi(transport, ConfigurationError) {
  this[kConfigurationError] = ConfigurationError;
 }

+/**
+ * The CAT aliases operation lists the mapping of aliases to indices, plus routing and filtering information.


Is it CAT or cat?

CAT is short for "Compact and Aligned Text". Opensearch docs also refers to it as CAT API. So, I think CAT is more accurate.

nhtruong · 2022-12-13T17:54:53Z

@harshavamsi @dblock This PR is now ready for review. I've added documentation for all API methods.
Check out the page on my fork to see what the docs look like: https://nhtruong.github.io/opensearch-js/2.1/

There will be a follow up PR to add this docs to the README after the github pages have been properly setup and tested on this repo.

Signed-off-by: Theo Truong <theotr@amazon.com>

ananzh · 2022-12-16T21:01:16Z

@nhtruong like these documents!! I just opened the attached url link and saw that the logo is not rendered properly. are you aware of this?

Signed-off-by: Theo Truong <theotr@amazon.com> Signed-off-by: Theo Truong <theotr@amazon.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Ajay Gupta <ajyg@amazon.com>

Signed-off-by: Theo Truong <theotr@amazon.com> Signed-off-by: Theo Truong <theotr@amazon.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>

* 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 <miki@amazon.com>

nhtruong marked this pull request as ready for review November 22, 2022 22:05

nhtruong requested review from ananzh, kavilla, mihirsoni, seanneumann, dblock and VachaShah as code owners November 22, 2022 22:05

nhtruong marked this pull request as draft November 28, 2022 17:50

nhtruong force-pushed the jsdoc branch 2 times, most recently from a0433ef to 05a805f Compare November 29, 2022 22:56

nhtruong marked this pull request as ready for review November 29, 2022 23:10

dblock reviewed Nov 30, 2022

View reviewed changes

nhtruong marked this pull request as draft December 5, 2022 18:07

nhtruong force-pushed the jsdoc branch 8 times, most recently from d10a1d5 to 1fab595 Compare December 13, 2022 17:18

nhtruong marked this pull request as ready for review December 13, 2022 17:52

Implement JSDOC

0331290

Signed-off-by: Theo Truong <theotr@amazon.com>

nhtruong force-pushed the jsdoc branch from 1fab595 to 0331290 Compare December 14, 2022 16:51

dblock approved these changes Dec 16, 2022

View reviewed changes

Merge branch 'main' into jsdoc

bebc8e4

dblock merged commit 4031f96 into opensearch-project:main Dec 16, 2022

ajygupta mentioned this pull request Jan 5, 2023

Added point in time APIs #348

Merged

AMoo-Miki mentioned this pull request Jul 12, 2023

Manual master cherrypick into 2.x #550

Merged

5 tasks

nhtruong deleted the jsdoc branch June 11, 2024 17:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement JSDOC #337

Implement JSDOC #337

nhtruong commented Nov 22, 2022 •

edited

Loading

harshavamsi commented Nov 22, 2022

nhtruong commented Nov 22, 2022 •

edited

Loading

nhtruong commented Nov 29, 2022

dblock left a comment

dblock Nov 30, 2022

dblock Nov 30, 2022

dblock Nov 30, 2022

nhtruong Nov 30, 2022

dblock Nov 30, 2022

nhtruong commented Dec 13, 2022

ananzh commented Dec 16, 2022

Implement JSDOC #337

Implement JSDOC #337

Conversation

nhtruong commented Nov 22, 2022 • edited Loading

Description

Issues Resolved

harshavamsi commented Nov 22, 2022

nhtruong commented Nov 22, 2022 • edited Loading

nhtruong commented Nov 29, 2022

dblock left a comment

Choose a reason for hiding this comment

dblock Nov 30, 2022

Choose a reason for hiding this comment

dblock Nov 30, 2022

Choose a reason for hiding this comment

dblock Nov 30, 2022

Choose a reason for hiding this comment

nhtruong Nov 30, 2022

Choose a reason for hiding this comment

dblock Nov 30, 2022

Choose a reason for hiding this comment

nhtruong commented Dec 13, 2022

ananzh commented Dec 16, 2022

nhtruong commented Nov 22, 2022 •

edited

Loading

nhtruong commented Nov 22, 2022 •

edited

Loading