Skip to content

Document the Object Store download permission rule - #2685

Merged
AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-object-store-download-docs
Sep 17, 2026
Merged

AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:feature-object-store-download-docs

Conversation

@AlexCatarino

@AlexCatarino AlexCatarino commented Sep 16, 2026

Copy link
Copy Markdown
Member

Summary

"How do I download my files from the Object Store?" is the most repeated support question with a fixed policy answer. The current Download Files page only says "contact us to unlock this feature", so every tier emails support and most get told no.

  • Rewrite Resources/object-store/download-files-from-cloud-permission.php (shared by the Cloud Platform, Organizations, and LEAN CLI Download Files pages) to state the rule up front: Institution tier plus the derived data agreement, not available on the other tiers, storage subscriptions don't change it, the gate covers every file including uploads and algorithm output, raw data is never exportable, and the API/CLI error text Organization does not have derivative export enabled. Lists the in-cloud alternatives (read in Research or a backtest, Download Results, log quota, lean cloud pull for project files). Replaces the broken mailto with the pricing page's demo wording and /appointments link.
  • Scope the click-through walkthrough in download-files-from-cloud.php to permissioned organizations and drop the old fallback paragraph (moved into the list above).
  • Cross-link from the Institution Tier and Trading Firm Tier pages and from the Storage Sizes table.
  • Add a description to /object/get in the OpenAPI spec and regenerate the Get Object Store File reference, which adds a Description page and renumbers Request and Responses (no docs link to those anchors).
  • Add download, export, derivative export, institution to both Object Store section keywords.
  • Backtesting Results: link each item on Download Results to its section, and note on Runtime Statistics that custom statistics appear in the banner and download with the results, with the limits from Adjust runtime statistics handling Lean#9760 (50 statistics, 200 characters, encoded values ignored, one debug message).

Test plan

  • code-generators/API-Reference-Code-Generator.py regenerated only the Get Object Store File folder; Request and Responses are byte-identical to the previous files.
  • vacuum lint QuantConnect-Platform-2.0.0.yaml --fail-severity error passes.
  • Every /docs/v2/...#anchor in the changed files resolves through doc_anchors.check_section_anchor.
  • Lean CLI relays the /object/get errors array verbatim (lean/components/api/api_client.py), so the error text customers quote appears in both the API and CLI.
  • Reviewer with a non-permissioned org: confirm what the Download button does on the Object Store page. Tickets report both a disabled button and a "Permissioned Institutional clients" notice; the text says the action "is unavailable" to cover both.
  • Confirm "derived data agreement" is the name of the signed document.

@AlexCatarino
AlexCatarino force-pushed the feature-object-store-download-docs branch from 71cdb15 to ddb8551 Compare September 16, 2026 23:15
Downloading from the Object Store is an Institution tier entitlement that
covers every file in the store, but the docs only said "contact us to
unlock this feature", so every tier writes to support. State the rule,
the tiers it excludes, the API/CLI error, and the in-cloud alternatives
on the Download Files pages, cross-link it from the Institution and
Trading Firm tier pages, the storage sizes table, and the /object/get
API reference, and fix the broken mailto.

Also link each item on the backtest Download Results page to its
section, and note on Runtime Statistics that custom statistics reach
the banner, report and download, with the limits from LEAN #9760.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@AlexCatarino
AlexCatarino force-pushed the feature-object-store-download-docs branch from ddb8551 to 2e495f0 Compare September 16, 2026 23:18
@AlexCatarino
AlexCatarino merged commit 1d5f67c into QuantConnect:master Sep 17, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the feature-object-store-download-docs branch September 17, 2026 10:44
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.

1 participant