Skip to content

Roadmap

mavrovde edited this page Nov 13, 2026 · 6 revisions

Roadmap

The work is planned in phases. Each phase ends with its acceptance tests green. No dates are promised: phases are delivered in order, and the next starts when the previous one is accepted. Current position: Project Status (phase 0 decided Go; phase 1, milestone 0.2.0, is in review).

flowchart LR
  P0[0 Benchmark and<br/>stack decision] --> P1[1 Skeleton]
  P1 --> P2[2 Contract and<br/>version sync]
  P2 --> P3[3 Keys and<br/>licence gate]
  P3 --> P4[4 Limits, tiers,<br/>deadlines, metering]
  P4 --> P5[5 Feature<br/>endpoints]
  P5 --> P6[6 Performance]
  P6 --> P7[7 Docs and<br/>first release]
  P7 --> L[Later]
Loading
Phase Delivers Accepted when
0 Benchmark and decision the two benchmark queries and the cancellation check in all three candidates; the written decision record; the licence matrix reviewed the owner approves the stack and the decision record is published
1 Skeleton configuration layer with generated reference, /healthz, /readyz, /v1/meta, /openapi.json, the container image, CI with security scanning, protected main; the read role and the first views on the platform side; the stub-database test harness tests, lint and static checks green; the image boots and answers /healthz with no secret inside; a write through the read role is refused
2 Contract and version sync the contract file and its generator, the version-sync pull request, automated releases a sync to a given platform version bumps the version, changelog and tag together; /v1/meta reports both versions; a mismatch is reported by the platform's deployment check
3 Keys and licence gate the access store, key issue / rotate / revoke, hashed storage, scopes, the licence gate in the query plus the post-check, audit log, log redaction every refusal path tested; no key in any log; a source a key may not receive is never returned to it
4 Limits, tiers, deadlines, metering per-key limits and quotas, priority admission, the 2 second deadline with database-side cancellation, hourly metering under synthetic overload the higher tier keeps its target while the lower tier gets 429 with Retry-After; no request runs past its deadline; usage per key and hour is readable
5 Feature endpoints the single-source features first, then the composed ones (route briefing, place overview); MCP parity tests the endpoint list is reviewed before implementation; no endpoint maps one-to-one to storage; at least one composed feature tested; parity and attribution on every endpoint
6 Performance ETag/304, result cache with single-flight, compression, query-plan tests, latency budgets in the pipeline every endpoint has a budget asserted by the benchmark leg; repeated requests are 304 or cache hits; no sequential scan on time-series data
7 Docs and first release the guide, the rendered reference, a page per error type, executed examples, the first published image, the public API host every endpoint documented with examples and attribution, examples executed in CI; a release publishes the image and the docs

Milestones and planned versions

Each phase is one GitHub milestone and ends with a release. Until the first public release, versions are 0.x pre-releases (Semantic Versioning: anything may still change). From the first public release on, the release version is kept in step with the ViaFrei platform version (Compatibility and Versioning); the interface path stays /v1 throughout.

Version Milestone Phase Issues Test exit criteria
0.1.0 Stack decision 0 #2, #13 Test Plan, 0.1.0
0.2.0 Skeleton and pipeline 1 #3, #5, #11, #12, #14 Test Plan, 0.2.0
0.3.0 Contract and version sync 2 #6, #15, #16 Test Plan, 0.3.0
0.4.0 Keys and licence gate 3 #7, #17 Test Plan, 0.4.0
0.5.0 Limits, tiers and deadlines 4 #8 Test Plan, 0.5.0
0.6.0 Feature endpoints 5 #10, #18 Test Plan, 0.6.0
0.7.0 Performance 6 #9, #19 Test Plan, 0.7.0
platform version at release First public release 7 #4, #20 Test Plan, first public release
— Later not scheduled — —

A phase may ship more than one patch release (0.2.1, …); a phase is closed when its milestone has no open issue, its acceptance row above is met and the test exit criteria of its Test Plan section hold. The approach behind those criteria is on Testing Strategy.

Feature order within phase 5 (planned)

  1. Places: search, describe a point, addresses, points of interest.
  2. Road conditions: motorways, motorway conditions, roadworks ahead, conditions in an area.
  3. Energy: refuel and charging options, near a point and along a corridor.
  4. Parking and car sharing.
  5. Public transport: stop search, departures, disruptions; station accessibility.
  6. Weather risk and driving rules.
  7. Composed features: route briefing, place overview.
  8. Condition history (bounded windows, cursor pagination).

The order may change after the owner's review of the endpoint list.

Later (not scheduled)

  • Webhooks or server-sent events for watching a situation.
  • OAuth 2.1 client credentials for enterprise integrations, once the specification is final.
  • A screen in the owner console for key management (the command-line tool comes first).
  • More capacity, larger pools, and then, if needed, several instances with shared limit state, a central connection pooler and a read replica.
  • An OGC API – Features endpoint for GIS clients.
  • Bulk exports as asynchronous jobs.

Home

About

Design

Data Model

Technical specification

Testing

Engineering

Technology choice

Reference

Clone this wiki locally