Expand the CATMAID docs section into one runnable card per command - #98
Merged
Conversation
The pass-through's 50 commands were a flat reference table inside the
generic /catmaid/{instance}/{command} card — readable, not runnable. The
CATMAID group now ends with a collapsed 'all commands' block holding one
card per registry command, generated client-side from the vocabulary
/docs.json already carries: each card shows the upstream CATMAID call it
wraps, the command's own parameters with runnable pre-filled examples
(id-taking parameters pre-filled with convertible VFB ids), the shared
instance dropdown, and project/raw/extra. Endpoint-card construction is
factored out of render() and reused; the old table (and its CSS) goes.
Verified live: neuron_names runs from its card against fafb with the
mixed-id example and renders the envelope.
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.
What changed
The pass-through's 50 commands were a flat reference table inside the generic
/catmaid/{instance}/{command}card — readable, not runnable. The CATMAID group now ends with a collapsed "all commands" block holding one card per registry command, generated client-side from the vocabulary/docs.jsonalready carries: each card shows the upstream CATMAID call it wraps, the command's own parameters with pre-filled runnable examples (id-taking parameters get convertible VFB ids), the shared instance dropdown, and project/raw/extra. Endpoint-card construction is factored out and reused; the old table and its CSS go. New commands added to the registry appear on the page with no docs change.How to test
pytest tests/test_api_docs.py, thenpython -m vfbquery.ha_api, open/, expand the CATMAID "all commands" block and runneuron_names— the pre-filled mixed VFB-id/skid example returns the envelope.