Document spice-query and metakernel APIs

[tmplummer]

Overview

The spice-query and metakernel APIs are public but lack documentation. This ticket is for adding documentation to the imap-data-access REST API documentation section.

See: imap_processing/docs/source/data-access/index.rst

Relevant code to reference for query parameters:
metakernel: https://github.com/IMAP-Science-Operations-Center/sds-data-manager/blob/dev/sds_data_manager/lambda_code/SDSCode/api_lambdas/spice_metakernel_api.py#L174
spice-query:https://github.com/IMAP-Science-Operations-Center/sds-data-manager/blob/dev/sds_data_manager/lambda_code/SDSCode/api_lambdas/spice_query_api.py#L17

Related documents or information sources

No response

[tmplummer]

Metakernel query: This is used to get either a metakernel or complete list of kernels covering a date/time range
API endpoint: https://api.dev.imap-mission.com/metakernel
Query Parameters:

• start_time (string) - coverage start time: either TDB seconds
• end_time (string) - coverage end time: either TDB seconds
• spice_path (string) - root path for spice directory. This path will be prepended to kernel locations in metakernel
• list_files (string, truthy) - "True" or "False". If False, a metakernel will be returned otherwise, just a list of files will be returned
• require_coverage (string, truthy) - "True" or "False". If True, query will fail if gaps are present in in coverage range.
• file_types (string) - list of spice file types. Types include: leapseconds,planetary_constants,science_frames,imap_frames,spacecraft_clock,planetary_ephemeris,ephemeris_reconstructed,ephemeris_nominal,ephemeris_predicted,ephemeris_90days,ephemeris_long,ephemeris_launch,attitude_history,attitude_predict,pointing_attitude

Example query urls:
https://api.dev.imap-mission.com/metakernel?start_time=797949057&end_time=798035454&file_types=leapseconds,spacecraft_clock,imap_frames,science_frames,planetary_ephemeris,ephemeris_reconstructed,attitude_history&list_files=True
https://api.dev.imap-mission.com/metakernel?start_time=797949057&end_time=798035454&file_types=leapseconds,spacecraft_clock,imap_frames,science_frames,planetary_ephemeris,ephemeris_reconstructed,attitude_history&spice_path=/foo/path/imap

General spice query: This can be used to get information about a specific kernel, or get the kernel(s) of a single type that cover a time range.
API endpoint: https://api.dev.imap-mission.com/spice-query
Query Parameters:

• file_name (string) - Spice kernel file name
• start_time (string) - coverage start time in TDB seconds
• end_time (string) - coverage end time in TDB seconds
• type (string) - spice kernel type. Accepted types are: leapseconds,planetary_constants,science_frames,imap_frames,spacecraft_clock,planetary_ephemeris,ephemeris_reconstructed,ephemeris_nominal,ephemeris_predicted,ephemeris_90days,ephemeris_long,ephemeris_launch,attitude_history,attitude_predict,pointing_attitude
• latest (string, truthy) - only return latest version of spice kernel(s) matching query parameters

Example urls:
https://api.dev.imap-mission.com/spice-query?start_time=797949057&end_time=797949059&type=attitude_history
https://api.dev.imap-mission.com/spice-query?file_name=imap_001.tf

[tech3371]

@bourque This is another documentation ticket we can use help with. Tim helped captured lot of information to start. Appreciate the help!