Skip to content

Commit

Permalink
Don't require a leading dot for JSON field paths
Browse files Browse the repository at this point in the history
https://github.com/kubernetes/community/blob/ddc11a7/contributors/devel/sig-architecture/api-conventions.md#selecting-fields

This allows us to leverage existing libraries and patterns designed for Kubernetes field paths.
  • Loading branch information
negz authored Mar 28, 2020
1 parent 0b34041 commit 72eecb6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion 4.component.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The Parameters section defines all of the configurable parameters for this compo

Parameter `name` fields must be Unicode letter and number characters. Application Configurations will specify parameters values using this name.

Parameter `fieldPaths` specifies an array of fields within this Component's workload that will be overwritten by the value of this parameter. `fieldPaths` are specified as JSON field paths with a leading dot, for example `.spec.containers[0].image`. The type of the parameter is inferred by the type of the fields to which those paths refer. Thus, all fields to which those paths refer MUST have the same type and MUST NOT be object type.
Parameter `fieldPaths` specifies an array of fields within this Component's workload that will be overwritten by the value of this parameter. `fieldPaths` are specified as JSON field paths without a leading dot, for example `spec.containers[0].image`. The type of the parameter is inferred by the type of the fields to which those paths refer. Thus, all fields to which those paths refer MUST have the same type and MUST NOT be object type.

### Examples

Expand Down

0 comments on commit 72eecb6

Please sign in to comment.