Add field-level metadata generation for mmv1 resources #12792
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
|
Hi there, I'm the Modular magician. I've detected the following information about your changes: Diff reportYour PR generated some diffs in downstreams - here they are.
|
melinath
approved these changes
Jan 17, 2025
| func (r Resource) LeafProperties() []*Type { | ||
| types := r.AllNestedProperties(google.Concat(r.RootProperties(), r.UserVirtualFields())) | ||
|
|
||
| // Remove types that have children, becasue we only want "leaf" fields |
There was a problem hiding this comment.
sp - feel free to ignore
Suggested change
| // Remove types that have children, becasue we only want "leaf" fields | |
| // Remove types that have children, because we only want "leaf" fields |
| @@ -198,3 +198,105 @@ func TestResourceServiceVersion(t *testing.T) { | |||
| }) | |||
| } | |||
| } | |||
|
|
|||
| func TestLeafProperties(t *testing.T) { | |||
There was a problem hiding this comment.
would it be useful to have tests for non-nested leaf properties to cover the base case?
Comment on lines
+8
to
+9
| - | ||
| field: '{{ $p.MetadataLineage }}' |
There was a problem hiding this comment.
I think this newline isn't necessary / isn't how we generally format our yaml. It adds a lot of whitespace to the yaml file.
Suggested change
| - | |
| field: '{{ $p.MetadataLineage }}' | |
| - field: '{{ $p.MetadataLineage }}' |
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.
This is the initial pass at adding field metadata to all mmv1 resources. I was able to check a small set of resources for accuracy, but further accuracy improvements are expected to come after we have the data ingested and can more clearly run checks.
Notable decisions:
api_fielddefault to the value offieldwhen it isn't specified, so that it does not need to be included for the vast majority of fields. This massively reduces the size and visual noise in metadata files, which will be helpful for handwritten resources later.key/valuemetadata fields for maps, even though that is how they are described in the API, because it isn't meaningful for coverage. Maps are treated like a single field.Release Note Template for Downstream PRs (will be copied)
See Write release notes for guidance.