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

[8.x] 🌊 Refactor APIs to follow Elasticsearch conventions (#204671) #205121

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from

Conversation

flash1293
Copy link
Contributor

Backport

This will backport the following commits from main to 8.x:

## Summary

This PR refactors the API by creating a new packaged called
`@kbn/streams-schema` where you can find all the Zod types along with
some type guards. I've also updated all the API's and calls to use the
new schemas.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Joe Reuter <johannes.reuter@elastic.co>
(cherry picked from commit 5ae53d4)

# Conflicts:
#	.github/CODEOWNERS
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
streamsApp 168 200 +32

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/streams-schema - 84 +84
streams 13 9 -4
total +80

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id before after diff
@kbn/streams-schema - 12 +12

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
streamsApp 116.6KB 186.5KB +69.9KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
streams 3 2 -1
Unknown metric groups

API count

id before after diff
@kbn/streams-schema - 84 +84
streams 13 9 -4
total +80

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants