Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIv4 - Rename 'controlField' property to 'control_field' #19699

Merged
merged 1 commit into from
Mar 1, 2021

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Mar 1, 2021

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.

…ency

By convention, all keys returned from the api should be lowercase.
@civibot
Copy link

civibot bot commented Mar 1, 2021

(Standard links)

@civibot civibot bot added the master label Mar 1, 2021
@colemanw
Copy link
Member Author

colemanw commented Mar 1, 2021

@eileenmcnaughton this is per our discussion on #19629

@eileenmcnaughton
Copy link
Contributor

OK - I did a universe grep & the only other related place was the old afform module - which should be gone by this version anyway now.

Test fails are leap year related & affect a bunch of PRs today

@eileenmcnaughton eileenmcnaughton merged commit a6ba1fe into civicrm:master Mar 1, 2021
@eileenmcnaughton eileenmcnaughton deleted the controlField branch March 1, 2021 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants