Add Pointings, Identifications, and Mag Bands API docs and tutorials#38
Draft
matthewjohnpayne wants to merge 5 commits intomainfrom
Draft
Add Pointings, Identifications, and Mag Bands API docs and tutorials#38matthewjohnpayne wants to merge 5 commits intomainfrom
matthewjohnpayne wants to merge 5 commits intomainfrom
Conversation
Add tutorial notebooks for the Pointings API (demonstrating all four field geometry options) and Identifications API, along with the Pointings API documentation page. Both tutorials use markdown-only submission cells to prevent accidental production submissions. Co-Authored-By: Claude Opus 4.6 <[email protected]>
- Migrate Mag Bands API docs from legacy site to apis/mag-bands.md with corrected API details (GET not POST, flat payload, real response fields: allowed, notes, v_conversion) - Add Mag Bands tutorial notebook with live API examples - Fix pointings notebook: true -> True (Python boolean) - Handle None values in mag-band API responses for band/notes fields - Update APIs index and api_tutorials.md with new links - Update CLAUDE.md migration notes Co-Authored-By: Claude Opus 4.6 <[email protected]>
Create apis/identifications.md as the canonical API reference for the Identifications submission endpoint, consolidating endpoint, JSON structure, examples, and Python usage into the apis/ section. Replace all references to identifications/submission-format.md with links to the new API page (identifications index, acceptance-criteria, tutorial notebook) and delete the now-redundant submission-format.md. Co-Authored-By: Claude Opus 4.6 <[email protected]>
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.
This PR is a WIP:
mpc_apipackage (introduced in Mpc api #32) as part of this WIP PR.Summary
apis/pointings.mdapis/mag-bands.md(with corrected API details: GET not POST, flat payload structure, actual response fields)Details
Pointings tutorial (
mpc_tutorial_api_pointings.ipynb): Demonstrates all four field geometry options (square, circular, tangent-plane offsets, rectangular). Submission code is in markdown-only cells to prevent accidental production POSTs.Identifications tutorial (
mpc_tutorial_api_identifications.ipynb): Covers DES-to-DES, ITF-to-DES, ITF-to-ITF, and NEOCP linkage types. Submission code is in markdown-only cells.Mag Bands tutorial (
mpc_tutorial_api_mag_bands.ipynb): Fully executable read-only API tutorial. Queries single bands, all bands, demonstrates response fields (band,notes,allowed,v_conversion), and includes a helper function.Test plan
mkdocs build --strictpasses with no errors🤖 Generated using Claude Code