Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New type definitions #1358

Merged
merged 27 commits into from
Mar 24, 2021
Merged

New type definitions #1358

merged 27 commits into from
Mar 24, 2021

Conversation

delvedor
Copy link
Member

This PR introduces type definitions for requests, responses, and the client itself. There are different noticeable changes, almost all of them will cause a breaking change typescript wise:

  • The RequestParams export has been removed
  • A new types export has been added, containing the full type definition of Elasticsearch endpoints.
  • The client type definition has been rewritten from scratch. Now every API accepts a generic only if the specific API needs to have a generic. You can no longer inject a custom definition per endpoint.

The types are not yet complete, there is still a lot of work to do. We are publishing them early to solicit feedback sooner rather than later. If a definition is broken for you and you can't wait for a fix, please use the @ts-expect-error comment. In this way, as soon as the definition is fixed, you will get a compilation error.

There are some APIs (brand new ones) that are not yet covered, those API will have the TODO type, which is an alias to Record<string, any>.

* Fix yaml parser and crash on failure

* Log response in case of ResponseError

* Updated cleanup

* Updated skip list

* Updated skip list

* Updated skip list
@delvedor delvedor marked this pull request as ready for review March 24, 2021 13:47
@delvedor delvedor merged commit f86a79c into master Mar 24, 2021
@delvedor delvedor deleted the type-definitions branch March 24, 2021 13:50
@github-actions
Copy link
Contributor

The backport to 7.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-7.x 7.x
# Navigate to the new working tree
cd .worktrees/backport-7.x
# Create a new branch
git switch --create backport-1358-to-7.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick ---mainline 1 f86a79cb26821ed7a748f54a6dbf51cd61471460
# Push it to GitHub
git push --set-upstream origin backport-1358-to-7.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-7.x

Then, create a pull request where the base branch is 7.x and the compare/head branch is backport-1358-to-7.x.

delvedor added a commit that referenced this pull request Mar 24, 2021
miloszmarcinkowski added a commit to elastic/kibana that referenced this pull request Sep 5, 2024
…types` (#192059)

Closes #190497 

## Summary

This PR replaces infra aggregation types with types provided by the
[Elasticsearch
client](elastic/elasticsearch-js#1358).

### Testing

not applicable

### Checklist

Delete any items that are not applicable to this PR.

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant