Expose JSON endpoint for Waffle flag/switch/sample state #452
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
added 5 commits
July 22, 2022 06:45
clintonb
reviewed
Jul 22, 2022
clintonb
approved these changes
Jul 23, 2022
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.
Why
Waffle currently has a view to expose flag/switch/sample state as a Javascript object via the WaffleJS endpoint.
But there are a number of use cases where it would be preferable to expose that state in a serialized format like JSON.
(Related Issue: #449)
What
Adds a JSON endpoint that returns the state of all flags/switches/samples.
In addition to the state, the endpoint also includes the last-modified time, which can be useful to identify stale flags that may need to be cleaned up.
Quality
Adds unit tests for the new
waffle_statusview.Adds documentation about how to expose and query the endpoint.