Add SavedObjectsUtils.getConvertedObjectId function #107767
Merged
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
Also change document migrator code to use this function instead of using uuidv5 directly.
jportner
added
v8.0.0
release_note:skip
jportner
commented
Aug 5, 2021
Comment on lines
+11
to
+24
| ```typescript | ||
| static getConvertedObjectId(namespace: string | undefined, type: string, id: string): string; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | namespace | <code>string | undefined</code> | | | ||
| | type | <code>string</code> | | | ||
| | id | <code>string</code> | | | ||
|
|
||
| <b>Returns:</b> | ||
|
|
There was a problem hiding this comment.
I wonder why the doc generator didn't pick up the parameter descriptions or the return description 🤔
There was a problem hiding this comment.
A couple ideas:
- The script doesn't regen the docs if the signature didn't change, so if you add the comments on the params after generating this the first time it may not be populated. You can add the
--docsCLI arg to force this - I wonder if the
{string}type descriptors are a problem? I usually don't use these since that info is already in the TS signature itself. Not sure how our doc generator handles these. - It may not matter much, we're about to remove this tooling.
joshdover
approved these changes
Aug 5, 2021
Comment on lines
+11
to
+24
| ```typescript | ||
| static getConvertedObjectId(namespace: string | undefined, type: string, id: string): string; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | namespace | <code>string | undefined</code> | | | ||
| | type | <code>string</code> | | | ||
| | id | <code>string</code> | | | ||
|
|
||
| <b>Returns:</b> | ||
|
|
There was a problem hiding this comment.
A couple ideas:
- The script doesn't regen the docs if the signature didn't change, so if you add the comments on the params after generating this the first time it may not be populated. You can add the
--docsCLI arg to force this - I wonder if the
{string}type descriptors are a problem? I usually don't use these since that info is already in the TS signature itself. Not sure how our doc generator handles these. - It may not matter much, we're about to remove this tooling.
jportner
added
the
auto-backport
💚 Build SucceededMetrics [docs]To update your PR or re-run it, just comment with: |
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Aug 5, 2021
kibanamachine
added a commit
that referenced
this pull request
Aug 5, 2021
streamich
pushed a commit
to vadimkibana/kibana
that referenced
this pull request
Aug 8, 2021
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.
Also change document migrator code to use this function instead of using uuidv5 directly.
Resolves #107744