Skip to content

docs: add API implementation status inventory - #26

Merged
priscaenoch merged 1 commit into
octraban:mainfrom
drojas1316:docs/feature-surface-inventory
Jul 18, 2026
Merged

docs: add API implementation status inventory#26
priscaenoch merged 1 commit into
octraban:mainfrom
drojas1316:docs/feature-surface-inventory

Conversation

@drojas1316

Copy link
Copy Markdown
Contributor

Closes #11

Summary

This pull request adds docs/STATUS.md, a documentation file that provides a complete inventory of the TypeScript API surface under src/api.

The goal is to make it clear which modules are production-ready, experimental, or backed by mock/stub implementations, while also defining a clearer boundary between the core explorer backend and specialized feature areas.

What was added

  • Inventoried all 126 TypeScript files under src/api.
  • Classified 123 primary API modules as:
    • 1 Production-ready
    • 113 Experimental
    • 9 Mock/stub
  • Identified 3 support-only helper files.
  • Documented the registration and role of the main API routers.
  • Added concrete implementation gaps for experimental and mock modules.
  • Linked mock/stub modules to the relevant tracking issues where available.
  • Added recommendations for which modules should:
    • remain in the core backend;
    • remain in core but be marked as experimental;
    • move to separate packages;
    • be removed or disabled until fully implemented.
  • Proposed package boundaries for areas such as:
    • MEV and trading intelligence;
    • risk and compliance;
    • predictive and oracle intelligence;
    • experimental operations tooling;
    • independent data products.
  • Added prioritized next steps for improving production readiness, testing, ownership, and package separation.

Why this change is needed

The backend currently exposes a very large and mixed API surface. Some modules use real execution paths, while others are incomplete, experimental, unmounted, or depend on hardcoded and mock data.

Without a centralized status document, it is difficult for maintainers to determine:

  • which endpoints are safe to operate as production features;
  • which modules still require validation or testing;
  • which endpoints may return mock or placeholder data;
  • which features belong to the core explorer backend;
  • which specialized domains should be isolated into separate packages.

docs/STATUS.md provides an operational map of the current API surface and makes these boundaries explicit.

Scope

This is a documentation-only change.

No application source code, tests, configuration files, or dependencies were modified.

Validation

  • Confirmed 126 TypeScript files under src/api.
  • Confirmed 123 primary API modules and 3 support helpers.
  • Confirmed status totals:
    • 1 Production-ready
    • 113 Experimental
    • 9 Mock/stub
  • Verified that each primary module has a repository-boundary recommendation.
  • Verified that docs/STATUS.md is the only changed file.

@priscaenoch
priscaenoch merged commit da1a1c2 into octraban:main Jul 18, 2026
3 checks passed
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.

Inventory and document the production vs experimental feature surface

2 participants