-
Committer:
Jeff Stys
-
Date:
2014-03-27 14:58:12 UTC
-
Revision ID:
jstys@sesda3.com-20140327145812-w6zfy2rd8nrexvm6
Overhaul of API Documentation, Sidebar Toggle, Movie Player Dialog updates, Bug Fixes.
Overhaul of API documentation:
+ API documentation now lives at its own URL: api/docs/v1/
+ API documentation has been separated from the API execution code to prevent documentation changes from interrupting live API requests.
+ API descriptions have been movied to verion-specific XML file(s), freeing it from the shackles of HTML and CSS markup.
+ Invalid API requests now display the documentation for the requested API action on the error page.
Hiding of News/Video sidebar
+ Added an icon button to the bottom of the Viewport to toggle the right-hand sidebar.
+ Modified the behavior of the fullscreen toggle to be compatible with the show/hide sidebar feature.
+ Added a keyboard shortcut, 's' to toggle the sidebar.
Miscellaneous Changes:
+ HV_API_URL is now used to prevent occassionaly problematic relative URLs.
+ For compatability reasons, an unexpected API parameter no longer results in an Exception. Instead, such parameters are explicitely unset.
+ Minor cosmetic changes to the movie player dialog.
+ Replaced AddThis with standard Twitter and Facebook buttons.
+ Added footer link to Helioviewer twitter account.
Bug Fixes:
+ Fixed a bug with the database query in getMovieInformation() that was preventing the LEFT JOIN from properly returning a result when the joined table (movieFormats) did not have any associated rows. A problem with the WHERE clause was eliminating the benefits of the LEFT JOIN.
+ Fixed a variable name typo associated with the mount wilson class event labels of NOAA SWPC Observer active regions.
+ Fixed a bug that was causing embedded Wordpress widgets to make an external API request to the HEK HER API when it wasn't necessary.
Apache Configuration Changes:
+ Need to add mod_rewrite rule to support version-specific API URIs (in use now by the API documentation).
RewriteRule ^/api/(v[0-9\.]+)/([0-9a-zA-Z]*)/ /api/index.php?action=$2 [QSA,L]