Description of managedFields.fieldsV1 in ObjectMeta is garbled
torinmr opened this issue · comments
Found in an auto-generated page: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#System
The field managedField.fieldV1 has the following description:
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
*FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff*
The third paragraph especially doesn't really make sense, it seems to be missing a lot of words.
The description seems like it may be sourced from this file, which makes a bit more sense.
As an additional note, I've been able to find the "exact format" referred to in the last paragraph, could that be replaced with a more specific reference?
This issue is currently awaiting triage.
SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.
The triage/accepted label can be added by org members by writing /triage accepted in a comment.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
/language en
/sig docs
/sig api-machinery
This is an autogenerated page the fix need to be done in the code. Cannot be fixed in the documentation.
I will raise a PR for this
/assign