bring new format field to events endpoint tobe able to eventsapi simp…#498
Open
mudhoney wants to merge 2 commits into
Open
bring new format field to events endpoint tobe able to eventsapi simp…#498mudhoney wants to merge 2 commits into
mudhoney wants to merge 2 commits into
Conversation
…le event search will simplify our system , step to eventually remove tree format event responses, which brings unneccessary complication to our codes
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add
format=tree|flatparameter toeventsactionformatquery parameter on?action=events: defaults totree(existing nested-category behaviour) orflatto fetch from the new v1 per-source endpoint.EventsApi::getEventsForSource()(declared onEventsApiInterface), which hits/api/v1/events/{source}/observation/{ISO-8601-Z}and mirrors the Legacy method's Sentry/exception handling.SolarEvents::events()now picks the right backend based onformat; the hardcoded['CCMC','HEK','RHESSI']list is replaced withEventsApi::VALID_SOURCESso future additions need one edit.formatas an optional choice restricted to{tree, flat}— anything else is rejected at the validator and the controller defensively falls back totree.