docs(parameters): clarify caching behavior of getAppConfig
#3808
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
documentation
|
dreamorosi
requested review from
am29d and
leandrodamascena
and removed request for
am29d
leandrodamascena
approved these changes
Apr 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Changes
This PR adds a callout to the
getAppConfig()docs section to make it explicit that the underlying AppConfig provider is cached.This means customers can only retrieve configurations within the same application/environment combination.
This is generally ok, since configurations should be mapped to a specific application/environment, however based on the linked issue it appears that some customers might be organizing configs differently.
--
The PR also makes two minor, unrelated, fixes to other broken references that I noticed in the docs build logs while testing this.
Issue number: closes #3801
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.