Repository navigation
Spec Data Licensing and Attribution
Part of the Technical Specification. Requirement prefix: LIC. Principle: Principles section 1, "Data licences and attribution are law".
The API serves data under several categories of terms. The real assignment of each source family is the reviewed licence matrix (pending, see Project Status); until a family is reviewed, the gate denies it.
| Category | Examples | What the API must do |
|---|---|---|
| Attribution licences | CC BY 4.0, DL-DE BY 2.0 | Carry the attribution text, licence name and URL; state that changes were made |
| Zero-restriction licences | DL-DE Zero 2.0, CC0 1.0 | Carry the source name as good practice; no conditions |
| Share-alike licences | ODbL 1.0, CC BY-SA 4.0 | Carry attribution and the share-alike flag; point to the share-alike offer of the derived database; pass the obligation to clients |
| Restricted-purpose terms | consumer information only; non-commercial only | Serve only to plans whose use class the terms permit; carry the purpose note verbatim |
| Terms requiring acceptance | terms the key holder must accept explicitly | Withhold until acceptance is recorded (SEC-034); carry the condition note verbatim |
| Official texts | official warnings and similar public-authority publications | Carry the issuer, keep the original wording available, never alter levels |
How every stored record links to its source, publisher and licence: Data Model: Provenance.
{
"family": "places.open_map",
"publisher": "OpenStreetMap contributors",
"text": "© OpenStreetMap contributors, ODbL 1.0",
"licence": "Open Database License 1.0",
"licenceId": "ODbL-1.0",
"licenceUrl": "https://opendatacommons.org/licenses/odbl/1-0/",
"shareAlike": true,
"shareAlikeOffer": "https://api.viafrei.de/v1/sources#places.open_map",
"changesMade": "Selected, normalised and combined with other sources.",
"termsUrl": null
}| Member | Rule |
|---|---|
family |
The source family id, stable, generic, never a feed or system name |
publisher |
The publisher as its licence asks to be named |
text |
The exact attribution notice the licence requires; clients displaying the data MUST show it |
licence, licenceId, licenceUrl
|
Name, SPDX identifier where one exists (else a documented id such as DL-DE-BY-2.0), canonical URL |
shareAlike |
True for share-alike data |
shareAlikeOffer |
Where the derived database is offered under the same licence, required when shareAlike
|
changesMade |
The modification statement licences like CC BY 4.0 and DL-DE BY 2.0 require |
termsUrl |
The terms a client must accept or follow, when any |
meta.notes.condition[] and meta.notes.purpose[] hold objects {"family", "text", "lang"}. Condition notes state legal conditions of use; purpose notes state the purpose the data may serve (for example "for consumer information only"). They are legal conditions, not captions.
| ID | Requirement | Verification |
|---|---|---|
| LIC-001 | Every data response MUST carry the attribution of every family that contributed, and of every family consulted for an empty answer (ENV-003). | Contract |
| LIC-002 | Every data response MUST carry Link: <https://api.viafrei.de/v1/sources#<family>>; rel="license" for each contributing family. |
Handler |
| LIC-003 | Condition and purpose notes MUST be carried verbatim, in their original language, untranslated; a translation MAY be added in the documentation, never in place of the note. | Unit |
| LIC-004 | Attribution, notes and the share-alike flag MUST NOT be removable by fields, by the GeoJSON variant or by any other option. |
Handler |
| LIC-005 | Share-alike data MUST be flagged shareAlike: true with a shareAlikeOffer, and the documentation MUST explain that a client publishing a database derived from it takes on the same obligation. |
Docs |
| LIC-006 | Restricted-purpose data MUST be served only to plans whose use class is permitted (SEC-030), with the purpose note verbatim. | Security |
| LIC-007 | The terms of use of the API MUST be published, versioned, linked from /v1/meta and the documentation, and MUST require clients to pass attribution and notes on to their users wherever they display the data. |
Docs |
| LIC-008 | The attribution and notes texts MUST be generated from one register shared with /v1/sources and the licence gate (FR-SVC-002). |
Unit |
| LIC-009 | A family MUST be enabled for a use class only after its licence review is signed off and recorded; the record MUST name the reviewer and the date. | Review |
| LIC-010 | Payloads and documentation MUST NOT describe how any data was obtained; a source is named only as its attribution requires. | Lint |
| LIC-011 | Caching (in the service and permitted client caching) MUST NOT extend use beyond what the source's terms allow; where a source's terms limit retention, Cache-Control max-age MUST respect it. |
Review |
| LIC-012 | Mixing data under incompatible terms into one item MUST NOT occur; an item MUST come from one family or from families whose licences the review marked compatible. | Mapping |
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