Repository navigation
Contributing
viafrei-api is in its design phase. The most valuable contributions right now are questions, reviews of the design and proposals for the endpoint plan.
- Watch the repository (Releases, or All activity) to be notified of new releases and discussions.
- Issues track planned work, grouped by the phases on Roadmap.
- Pull requests show every change with its checks and review.
- Releases carry a generated changelog.
- This wiki is updated when the design changes; Project Status always reflects the current state.
- The ViaFrei website, viafrei.de, has news about the platform as a whole.
| You want to… | Do this |
|---|---|
| Ask a question about the design | Open an issue and describe your use case |
| Suggest an endpoint or a field | Open an issue: who needs it, the question it answers, an example request and response |
| Report a documentation error | Open an issue or a pull request against the documentation |
| Report a security problem | Use private vulnerability reporting on the repository (Security tab). Please do not open a public issue for a vulnerability |
Feature requests are judged by the domain question they answer, not by the data they expose. A request like "expose table X" will be reframed as "what question do you need answered?" (see Domain Model).
Once implementation starts:
- Open or pick an issue and say you are working on it.
- Fork, branch, and keep the change focused.
- Use a Conventional Commit title for the pull request.
- Include tests, documentation and examples in the same pull request.
- Make sure every required check is green.
- A code owner reviews; address the comments; the change is squash-merged.
- No live data-provider calls in tests. Use fixtures.
- Nothing about how data is collected, and no platform-internal names, in code, documentation or the OpenAPI document. The scope lint enforces this.
- Attribution on every data response.
- No tunable literals. Every timeout, limit and size is a configuration key with a default, bounds and a test.
- Public field names come from the domain, never from storage.
- No request may run longer than 2 seconds.
- Endpoints that let a caller filter or sort arbitrary storage columns.
- Changes that weaken the licence gate, attribution or key handling.
- Dependencies with licences incompatible with the project's licence, or unmaintained dependencies on critical paths.
Be respectful, precise and constructive. Disagreement about design is welcome when it comes with reasons.
ViaFrei API: a public, keyed, read-only REST API to live German mobility data. Design phase; nothing on these pages is a measurement of a running service. Data on viafrei.de and in every API answer is attributed to its publishers under their licences.
About
Design
- Domain Model
- API Design
- Architecture Overview
- Security and Access Keys
- Rate Limits and Priority
- Performance and Caching
- Configuration
- Observability
Data Model
Technical specification
-
Technical Specification
- Interface
- Scope, Conventions and References
- Protocol
- Common Envelope
- Resource Model
- Endpoints, Places
- Endpoints, Roads
- Endpoints, Energy and Parking
- Endpoints, Public Transport and Accessibility
- Endpoints, Weather Risk, Driving Rules and Composed Features
- Service Endpoints
- Errors
- Authentication and Authorisation
- Rate Limiting, Quotas and Priority
- Data Licensing and Attribution
- Compatibility and Versioning
- OpenAPI Skeleton
- Quality
- Delivery and operations
- Interface
Testing
- Testing Strategy
- Testing and Quality (design summary)
Engineering
Technology choice
- Technology Evaluation
- Architecture: Go
- Architecture: Rust
- Architecture: TypeScript
- Stack Comparison
- Benchmark Plan
Reference