[feature-request] Move variable coordinate-related parameters into a separate sub-array

Bug #313304 reported by Keith Hughitt
2
Affects Status Importance Assigned to Milestone
Helioviewer.org
Invalid
Undecided
Patrick Schmiedel

Bug Description

Queries to Helioviewer's Feature/Event Web-service return a list of "Event" objects each of which include a set of known/required parameters (catalogId, startTime, endTime,etc), as well as a list of catalog-specific parameters which are encapsulated in a "properties" subarray.

The "coordinates" portion of the main event object, however, still varies from catalog to catalog. For some catalogs the events include "hlat" and "hlong," for others: "polarCpa" and "polarWidth."

I propose that we create a new parameter "coordinates" which could encapsulate the variable aspect of the coordinate system. The types of parameters to expect could still be fully-determined based off the coordinateSystem property of associated catalog object, and the individual Event object parameters would now be uniform.

Revision history for this message
Patrick Schmiedel (patrick-schmiedel) wrote :

I was planning on doing something like that. Creating a seperate coordinates parameter seems like a good idea to me.

As this is a change to the interface, which leads to multiple changes in the implementations, I would like to get it right the first time, so if there are any more feature requests to the interface, please tell me in advance.

Also, are there any suggestions for improving the naming of coordinates? "hlat", "hlong", "polarCpa", "polarWidth" etc. are simply the designations used in the first data sources we used (NOAA and CACTus I think). Maybe "latitude", "longitude", "principalAngle", "paWidth" are better understandable?

Changed in helioviewer:
assignee: nobody → patrick-schmiedel
Revision history for this message
Keith Hughitt (keith-hughitt) wrote :

Regarding other changes to the interface, two things come to mind:

1) Should we require the "task" parameter both for querying available catalogs, and for querying events? e.g. task=getCatalogs, task=getEvents (on a similar note, what is the reasoning for naming the task for getting events "getPOI?")

2) For future support, should we add a "format" param? (which could be set to either "JSON" / "VOEvent" or "XML")

Revision history for this message
Keith Hughitt (keith-hughitt) wrote :

Legacy event marker system has been removed.

Changed in helioviewer.org:
status: New → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.