Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 9.97 KB

capability-reuse.md

File metadata and controls

46 lines (29 loc) · 9.97 KB

Build the next research App on existing OpenBB capabilities

Historical baseline: the tables below describe the 2026-10-28 inventory, before the initial provider batch and company selector shipped. For the current eleven-widget catalog, accepted selector and remaining quarterly/peer gaps, use the 2026-11-06 source findings. Its bounded IA-A requirements await owner approval; older future-tense status below is not the current delivery state.

Use the existing App, widget parameters, linked groups and renderers for the next Company Research delivery. First prove that one named company can drive its research views and survive save/reopen; then expand provider coverage. A second dashboard or selector framework is justified only if an observed requirement cannot be met by the existing implementation.

This 2026-10-28 inventory separates shipped evidence from source availability. Workspace source links are pinned to 22180d8ec206e088a384f2a3c7345358b1832c7c. The market-data and analyst-workspace requirements are scope stubs, not approved designs. The sequence below proposes their first bounded slice; it does not authorize all later implementation.

Reuse before extending

Accepted/runtime bounded means an identified application journey passed. Source present/configuration needed means the mechanism exists but the proposed App is not accepted. Unverified means source alone cannot establish the required behavior. Missing identifies an absent installed configuration or catalog entry, without claiming the upstream API lacks it.

Capability and owning spec Actual foundation Evidence status and smallest delta
Live data baseline: market-data-integrations Installed widget contract: FMP profile and income, FRED series Accepted/runtime bounded: onboarding proves live annual AAPL income and refresh. Three catalog widgets do not establish broad FMP or live FRED acceptance. Add and verify only the next required endpoint/widget.
Input controls: analyst-workspace Parameter schema supports text, date, ticker, number, boolean, endpoint, button, tabs and form; value defaults and label/value options already exist Source present/configuration needed: choose the existing control type and defaults for each financial parameter. Do not rebuild a selector framework.
Dependent options and named search: analyst-workspace; provider search: market-data-integrations Option resolution supports optionsEndpoint, optionsParams and $symbol dependencies; AdvancedSelectTicker supplies a named search control Unverified: installed backend name-search behavior is not established. Connect a real search response to the existing control, preserve name/symbol identity and test ambiguous names and empty results.
Shared company selection: analyst-workspace Group updater supports shared symbol and generic parameters; App schema includes groups, defaultValue, widgetIds, tabs, layouts and state.params Source present/configuration needed: starter App sets AAPL independently in two widgets, with no shared company group. The FRED App already declares a Series group. Configure a company group and prove all intended widgets follow one change.
App packaging, export and refresh: analyst-workspace App JSON export and widget auto-refresh exist Source present/configuration needed: define the App using current tabs/layout/parameters and suitable refresh intervals. Gallery persistence acceptance is bounded to that gallery; shared Company Research state still needs save/reopen and retained-container-state acceptance.
Price history, news, earnings calls and analyst views: market-data-integrations Existing catalog and provider coverage map Missing: dedicated live widgets for these views are absent from the installed catalog; broader statements also need coverage beyond income. A profile price field does not establish price-history coverage. This is not evidence of upstream API absence. Reuse available provider/Workspace paths where suitable; add catalog configuration, adapters or normalization only where inspection shows a gap. Verify entitlement and real responses.
Chart/table presentation: analyst-workspace Existing table, ECharts and Plotly paths; renderer status and widget mapping Accepted/runtime bounded for individual released chart journeys; reuse them. Unverified for the new App's data semantics and linked state. Perspective remains foundation only; production dashboard integration is not accepted. Highcharts dependencies/imports are removed, but legacy ChartHighcharts maps to UnsupportedRenderer; full former-caller parity remains open.

Existing catalog tests, catalog runtime tests and onboarding contract tests are reuse points, not new Company Research acceptance. No test run accompanies this documentation change; the proposed shared-company journey has no completed test or evidence claim.

The current FMP provider registration explicitly registers only EquityInfo and IncomeStatement. This is an installed-backend boundary as well as a small widget catalog. Before writing a new fetcher, inspect available upstream provider implementations and original Workspace widget/App definitions for a compatible implementation to restore or configure. Record API adaptation and entitlement gaps separately from presentation work.

Published frontend inspection supports Highcharts runtime removal. It does not close the legacy widget replacement gap or constitute a complete dependency-license audit.

Deliver one Company Research App first

After the current delivery, uv/Python packaging and Valkey work, specify a Company Research App around a shared name/symbol selection, with price, company profile, statements, news, earnings calls and analyst views. Begin with the existing profile/income widgets and group mechanism; add the absent views in small accepted increments. Keep unavailable views explicit until their installed catalog and provider paths work. Do not present uploaded historical gallery data as live research coverage.

Acceptance of each increment requires four connected proofs:

  1. Source: identify the reused mechanism and any necessary production delta, under one owning spec and criterion.
  2. Configuration: exercise the installed catalog/App, parameter defaults, dependent options and shared group membership in the real application.
  3. Real provider: compare returned values or content with a reference and label symbol identity, dates, currency, units, period/frequency, provenance and entitlement. Handle missing data and provider failure visibly.
  4. Save/reopen: change the company and relevant period, save, reopen in a fresh authenticated context and recreate the disposable container with retained state. Verify the selected instrument, layout, widget parameters and group membership, alongside clean diagnostics.

Then expand FMP research families and add yfinance/FRED or later providers for explicit gaps. A common control does not make their instruments, adjustment rules or frequencies interchangeable. Record actual tests and evidence in the breadth map; planned checks remain planned. Reconsider reuse only when a reproducible failure shows that the existing mechanism cannot meet an accepted requirement.

Scope groups by research meaning. A Company group can drive FMP profile, statements, news and estimates. A Date Range group can align equity, commodity and macro views without replacing a FRED series identifier with an equity symbol. Provider-specific instrument resolution and fiscal-period alignment remain data contracts to verify; existing parameter propagation does not solve them automatically.

Financial workflow acceptance

The investment-analysis contract supersedes a company-selector-only delivery objective. Existing parameter controls are the mechanism; quarterly analysis, peer valuation and an inspectable DCF/capital-cost bridge are the analyst outcomes. Reuse remains the default, while provider access and financial correctness need their own evidence.