APIv4 - Rename 'controlField' property to 'control_field' #19699
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.
Overview
By convention, all keys returned from the api should be lowercase.
This renames a key that was not. It was only used in 2 places.
Before
\Civi\Api4\Address::getFields()
returns'input_type' => ['controlField' => ...
After
\Civi\Api4\Address::getFields()
returns'input_type' => ['control_field' => ...
Comments
In general, it's not good to make "breaking changes" to our API, but this is a very obscure sub-property of only one entity that is only used by Afform so far, and APIv4 is still relatively new. IMO this is reasonably safe, and better now than later.