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

Api4 - Remove unused key from getFields #27060

Merged
merged 1 commit into from
Aug 13, 2023

Conversation

colemanw
Copy link
Member

Overview

Removes the unused custom_group_id key from APIv4 getFields, which was never populated.

Before

APIv4 getFields includes custom_group_id: null for every field, even custom fields. Obviously it doesn't work so safe to remove.

After

Removed.

Comments

It's not important enough for anyone to have noticed, we're better off without it.
Note that the name of the custom group is returned, which is more useful.

@civibot
Copy link

civibot bot commented Aug 12, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷

Introduction for new contributors
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers

@civibot civibot bot added the master label Aug 12, 2023
@larssandergreen
Copy link
Contributor

I'm not clear why any of these fields are being returned in getFields for every entity: help_pre, help_post, custom_field_id, custom_group_id.

@colemanw
Copy link
Member Author

@larssandergreen I think the original implementation of APIv4 getFields added things a bit too hastily and now we're stuck with them. But at least this one is broken so we can safely remove it :)

@larssandergreen
Copy link
Contributor

Ah, OK. I don't think I understand how custom_group_id is not implemented and custom_field_id is (they both seem to return null for every entity I try), so I'll leave this one for someone who understands better to review.

@colemanw
Copy link
Member Author

@larssandergreen they are only not null for custom fields. Or at least, custom_field_id will return a value. custom_group_id is always null:

image

@larssandergreen
Copy link
Contributor

I see. help_pre and help_post seem to be always null though, maybe they could be eliminated too?

@eileenmcnaughton
Copy link
Contributor

Merging this as this part seems OK althought @colemanw still a question in the discussion about the other fields

@eileenmcnaughton eileenmcnaughton merged commit a246cd9 into civicrm:master Aug 13, 2023
@eileenmcnaughton eileenmcnaughton deleted the dontGetFields branch August 13, 2023 23:00
@larssandergreen
Copy link
Contributor

I was wrong about help_pre and help_post as I was testing for Custom Field Groups, rather than Custom Fields. They are populated for Custom Fields.

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.

3 participants