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

add Api4 SettingsMeta entity and AdminUI Settings Inspector screen #31592

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

ufundo
Copy link
Contributor

@ufundo ufundo commented Dec 11, 2024

Overview

Adds an Api4 entity for inspecting settings meta and values.

Before

  • Lots of settings meta, not very discoverable

After

  • Find settings with a directory style format

Technical Details

Want to be careful about exposing sensitive values through the current_value key. Added a new is_secret to DSN and Password settings, but probably should be used in more places.

I could be convinced to hold back on the current_value column for now.

Copy link

civibot bot commented Dec 11, 2024

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this 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...

➡️ Online demo of this PR 🔗

@colemanw
Copy link
Member

@ufundo how is this different from the other Api4 Setting entity?

@michaelmcandrew
Copy link
Contributor

@colemanw - this might help answer your question civicrm/civicrm-docker#5

@ufundo - is there a link to a site where I can test this or should i do so locally?

@ufundo
Copy link
Contributor Author

ufundo commented Dec 11, 2024

@colemanw this one is reshaped to be a more standard entity, so it can work with SearchKit

@michaelmcandrew see here on the test site: http://core-31592-4jwhi.test-1.civicrm.org:8003/civicrm/admin/settings-inspector

@ufundo
Copy link
Contributor Author

ufundo commented Dec 11, 2024

@totten just tagging you here as I remembered we talked about setting discoverability back in Ashbourne, interested in your thoughts

@ufundo ufundo marked this pull request as ready for review December 11, 2024 23:16
@ufundo ufundo force-pushed the settings-inspector branch from 5d4432f to fbd5903 Compare December 11, 2024 23: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.

3 participants