[3.0 Beta] Auto Generated API #830
Closed
Conversation
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
Signed-off-by: Theo Truong <[email protected]>
nhtruong
changed the title
dblock
reviewed
Aug 12, 2024
| ### Deprecated | ||
| ### Removed | ||
| - *BREAKING* Removed support for API param aliases. That is, the API functions now only accept params with the exact names specified in the OpenSearch API specification. | ||
| - *BREAKING* Removed support for snake_cased API function names. All API functions are now camelCased only to conform to JavaScript naming conventions. |
There was a problem hiding this comment.
Create an UPGRADING.md that shows the changes with examples, e.g. https://github.com/opensearch-project/opensearch-py/blob/main/UPGRADING.md
| */ | ||
|
|
||
| /* | ||
| * This file was generated from OpenSearch API Spec. Do not edit it |
| /* | ||
| * This file was generated from OpenSearch API Spec. Do not edit it | ||
| * manually. If you want to make changes, either update the spec or | ||
| * the API generator. |
There was a problem hiding this comment.
Add something like "by running npm ..." or a mention of a doc like "see dev guide"
| const updateByQueryRethrottleApi = require('./api/update_by_query_rethrottle'); | ||
| const { kConfigErr, apiFunc } = require('./utils') | ||
| const kApiModules = Symbol('api modules') | ||
| const kApiLoader = Symbol('api loader') |
There was a problem hiding this comment.
Any reason why these aren't named, e.g. this._api_loader?
| sql: { get() { return this[kApiLoader]('./sql/_api') } }, | ||
| tasks: { get() { return this[kApiLoader]('./tasks/_api') } }, | ||
| transforms: { get() { return this[kApiLoader]('./transforms/_api') } }, | ||
| }) |
There was a problem hiding this comment.
It probably makes sense to have an explicit loadAll() as well to avoid warmup time during service. Doesn't need to be in this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.