Add upload workflow to NeuroJSON · Issue #147 · NeuroJSON/NeuroJSON_io · GitHub
Skip to content

Add upload workflow to NeuroJSON #147

Open

Description

@elainefan331

Description:
Add an authenticated upload and review workflow for submitting JSON and optional raw data to the NeuroJSON sandbox.
Users will upload through the login-protected /upload workflow on NeuroJSON.io. AutoBIDSify will provide a button that opens the NeuroJSON upload page in the browser.
The workflow includes:

  • Authenticated JSON dataset upload to the CouchDB sandbox
  • PostgreSQL submission and review tracking
  • Optional raw data ZIP upload using TUS
  • Direct browser-to-server raw data transfer and storage
  • Reviewer-controlled raw data extraction
  • Review, approval, and promotion workflow
  • Public DataLinks for promoted raw files

Tasks:

  • Add draft and submission workflow
  • Add raw data database tables
  • Add upload authentication and signing
  • Add REN raw upload APIs
  • Add REN ↔ Zodiac upload completion workflow
  • Add upload reconciliation and recovery — reconcile REN and Zodiac states and recover missed or stuck uploads.
  • Build Zodiac TUS storage service
  • Add raw ZIP uploader to the frontend
  • Add raw data extraction and reviewer access
  • Add reviewer workflow and dataset promotion
  • Add cleanup jobs
  • Deploy and test the complete workflow
  • Add Upload to NeuroJSON.io button in AutoBIDSify
  • Add email notifications

Acceptance Criteria:

  • Only authenticated users can upload datasets.
  • JSON uploads are stored in the NeuroJSON sandbox and tracked in PostgreSQL.
  • Raw data can be uploaded as a ZIP using a resumable upload workflow.
  • Raw data is stored separately from REN and can be associated with dataset submissions.
  • Upload failures, cancellations, and resumptions are handled correctly.
  • Reviewers can inspect submitted datasets and raw data before approval.
  • Reviewers can approve, reject, or request changes.
  • Approved datasets can be promoted to a public NeuroJSON database.
  • Public DataLink URLs resolve to the corresponding stored files.
  • The complete upload → review → promotion workflow can be tested end-to-end.

Activity

  1. self-assigned this
    on Sep 14, 2026
  2. changed the title [-]Add AutoBIDSify upload workflow to NeuroJSON[/-] [+]Add upload workflow to NeuroJSON[/+] on Sep 16, 2026
  3. 40 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions