Skip to content

Documentation for SPICE queries#3005

Merged
tmplummer merged 3 commits intoIMAP-Science-Operations-Center:devfrom
vineetbansal:vb/docs_spice
Apr 14, 2026
Merged

Documentation for SPICE queries#3005
tmplummer merged 3 commits intoIMAP-Science-Operations-Center:devfrom
vineetbansal:vb/docs_spice

Conversation

@vineetbansal
Copy link
Copy Markdown
Collaborator

@vineetbansal vineetbansal commented Apr 13, 2026

Added documentation for the /spice-query and /metakernel API endpoints, addressing issue #1825

Overview

Added documentation for the /spice-query and /metakernel API endpoints, addressing issue #1825

File changes

  • A new spice-files.rst
  • Added link to new rst from index.rst
  • New endpoints added to openapi.yaml.

Testing

A render of this documentation is at https://vineetb-imap-processing.readthedocs.io/en/latest/ in case we want to iterate on this.

Closes: #1825

Copy link
Copy Markdown
Contributor

@tmplummer tmplummer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is definitely an improvement on what we have! Just one comment about what URL is linked.

a ready-to-use metakernel (or a list of kernel filenames) that covers a
requested time range.

Both endpoints are accessible from the base URL: ``https://api.dev.imap-mission.com``
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably want to point to production at this point.

Suggested change
Both endpoints are accessible from the base URL: ``https://api.dev.imap-mission.com``
Both endpoints are accessible from the base URL: ``https://api.imap-mission.com``

This goes for all URLs in this file.

Copy link
Copy Markdown
Collaborator Author

@vineetbansal vineetbansal Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do. I used dev api endpoint since that's used everywhere else in the documentation (not just this page). Should I change those while we're at it?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ultimately, that would be it's own issue/PR, but I'm OK with adding that in here as long as it is fairly limited in the number of files it affects. If it is more than just a couple, lets do it in another issue.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done - it's limited to the 3 files in this folder so I hope its okay to change.

Copy link
Copy Markdown
Contributor

@tmplummer tmplummer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. This looks good to me with the one suggested change.

@tech3371
Copy link
Copy Markdown
Contributor

@tmplummer Can you merge this? Thank you for quick review!

@tmplummer tmplummer merged commit ec8864b into IMAP-Science-Operations-Center:dev Apr 14, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document spice-query and metakernel APIs

3 participants