-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
SavedObjectAttribute allow array of primitives #47317
Conversation
Pinging @elastic/kibana-platform (Team:Platform) |
ce9cf7f
to
f4245e0
Compare
💚 Build Succeeded |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
@@ -43,26 +43,33 @@ export interface SavedObjectsMigrationVersion { | |||
} | |||
|
|||
/** | |||
* Don't use this type, it's simply a helper type for {@link SavedObjectAttribute} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to remove the @public
annotation to assist with this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that was my first attempt, but then it also gets excluded from our generated docs and in effect a user reading the docs is left with just export type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttributeSingle[];
which isn't very useful :(
💚 Build Succeeded |
Summary
Changes the
SavedObjectAttribute
type to be more useful for other API's which accept method paramaters of the form(key: string, value: SavedObjectAttribute)
see #47018 (comment)Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.For maintainers