Skip to content

Brainstem client doc update#58

Open
petersenpeter wants to merge 4 commits intomainfrom
BrainstemClient-doc-update
Open

Brainstem client doc update#58
petersenpeter wants to merge 4 commits intomainfrom
BrainstemClient-doc-update

Conversation

@petersenpeter
Copy link
Copy Markdown
Collaborator

No description provided.

Standardize API documentation to use the BrainstemClient interface and clarify authentication. Replaces legacy helper calls (load_model/save_model/delete_model) with client.load/client.save/client.delete across modules, resources, dissemination, taxonomies and tutorials. Expands MATLAB and Python guides to show BrainstemClient usage, browser-based device auth (2FA), Personal Access Token workflow, headless mode, CLI commands, pagination and convenience loaders, and improves troubleshooting/security notes in the API token management page.
Replaced hardcoded example UUIDs and instance IDs with generic placeholders (e.g. <id>, <session-id>, <journal-id>, <inventory-id>, etc.) across API documentation. Changes touch docs/api-tools/matlab-api-tool.md, docs/api.md and numerous files under docs/api/ (dissemination, modules, personal_attributes, resources, stem, taxonomies, users) to avoid exposing real IDs and make examples clearer and more reusable.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates BrainSTEM documentation to reflect the current “API tools” client surface and authentication flow, aligning tutorials and endpoint references with the brainstem_api_tools BrainstemClient.

Changes:

  • Replace legacy brainstem_api_client + load_model/save_model/delete_model examples with brainstem_api_tools + load/save/delete.
  • Refresh auth docs to describe Personal Access Tokens and the browser-based device authorization flow (incl. headless flow).
  • Replace hard-coded UUID examples with <id>-style placeholders across API reference pages.

Reviewed changes

Copilot reviewed 45 out of 45 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/tutorials/two-photon-imaging-workflow.md Updates Python snippet to use brainstem_api_tools and client.load(...) with dot-notation filters.
docs/tutorials/managing-data-storage.md Migrates examples to client.load(...) and brainstem_api_tools; includes updated MATLAB snippet usage.
docs/tutorials/electrophysiology-workflow.md Migrates workflow API-access snippet to client.load(...) and updates model names/filters.
docs/api/users/user.md Switches user endpoint examples to load/save/delete.
docs/api/users/laboratory.md Switches laboratory endpoint examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/users/group_membership_request.md Switches group membership request examples to load and replaces concrete IDs with placeholders.
docs/api/users/group_membership_invitation.md Switches group membership invitation examples to load and replaces concrete IDs with placeholders.
docs/api/users/group.md Switches group endpoint examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/strain.md Switches strain/strainapproval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/species.md Switches species/speciesapproval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/setuptype.md Switches setuptype/setuptypeapproval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/regulatoryauthority.md Switches regulatoryauthority/approval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/brainregion.md Switches brainregion examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/behavioralparadigm.md Switches behavioralparadigm/approval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/taxonomies/behavioralcategory.md Switches behavioralcategory/approval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/subject.md Switches subject examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/session.md Switches session examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/project_membership_invitation.md Switches project membership invitation examples to load and replaces concrete IDs with placeholders.
docs/api/stem/project_group_membership_invitation.md Switches project group membership invitation examples to load and replaces concrete IDs with placeholders.
docs/api/stem/project.md Switches project examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/collection.md Switches collection examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/cohort.md Switches cohort examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/stem/breeding.md Switches breeding examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/resources/supplier.md Switches supplier/supplierapproval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/resources/hardwaredevice.md Switches hardwaredevice/approval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/resources/consumable.md Switches consumable/approval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/personal_attributes/setup.md Switches setup examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/personal_attributes/license.md Switches license examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/personal_attributes/inventory.md Switches inventory examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/personal_attributes/datastorage.md Switches datastorage examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/personal_attributes/behavioralassay.md Switches behavioralassay examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/subjectlog.md Switches subjectlog examples to load/save/delete (incl. options actions) and replaces concrete IDs with placeholders.
docs/api/modules/procedurelog.md Switches procedurelog examples to load/save/delete (incl. options actions) and replaces concrete IDs with placeholders.
docs/api/modules/procedure.md Switches procedure examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/manipulation.md Switches manipulation examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/equipment.md Switches equipment examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/dataacquisition.md Switches dataacquisition examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/consumablestock.md Switches consumablestock examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/modules/behavior.md Switches behavior examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/dissemination/publication.md Switches publication examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api/dissemination/journal.md Switches journal/journalapproval examples to load/save/delete and replaces concrete IDs with placeholders.
docs/api.md Rewrites token management docs around PATs + device auth flow; updates example URLs/placeholders.
docs/api-tools/python-api-tool.md Updates Python tool docs for device auth, load/save/delete, pagination, and convenience loaders.
docs/api-tools/matlab-api-tool.md Updates MATLAB tool docs for device auth, BrainstemClient usage, and convenience loaders.
docs/api-tools.md Adds a short note about PAT + browser-based device auth across tools.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

petersenpeter and others added 2 commits March 30, 2026 14:06
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Clarify and improve multiple tutorial pages:

- docs/tutorials/behavioral-assays.md: Mark key fields as required (setup type, behavioral paradigm, authenticated groups), change capitalization for consistency, and replace the JSON example with a concise table showing required fields.

- docs/tutorials/electrophysiology-workflow.md: Replace simplistic session/subject lookups with a robust sequence that resolves subject UUIDs via behavior records, collects session IDs, and fetches per-session extracellular ephys records (type 'ExtracellularEphys'); update example session name.

- docs/tutorials/managing-data-storage.md: Improve session loading to use include=['datastorage','projects'], update construct_data_path to accept an optional subject_name and handle datastorage as a list, add logic to retrieve subject names via behavior records, harden path construction and existence checks, and mirror these changes in the MATLAB example.

- docs/tutorials/two-photon-imaging-workflow.md: Small UI navigation copy edits, and update the example to resolve project UUIDs, load sessions with load_all, fetch per-session two-photon records using the corrected type 'TwoPhotonMicroscopy', and update example session name.

These edits improve accuracy of examples, better reflect API semantics (expanded includes, relationships via behavior records), and make path construction more robust.
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.

2 participants