Beta
Stability: Beta and Alpha
Every page and every endpoint carries a label. Each response says which one answered, in the Rana-Stability header
(beta or alpha).
| Label | What it covers today | What we promise |
|---|---|---|
| Beta | Everything except the Alpha items, including all three SDKs | No breaking change within v1 without 30 days' notice in the changelog |
| Alpha | Places (autocomplete, details, nearby search) and forward geocoding | Changes with 7 days' notice. Few or no results outside Lagos |
| GA | Nothing yet | A breaking change means a new /v2. /v1 keeps working |
Alpha products depend on our places data. That data is collected by people walking and riding the streets, so it is thickest in Lagos and grows from there.
What counts as a breaking change
Breaking:
- removing or renaming a field, a parameter or an error code;
- changing a field's type or unit;
- making an optional parameter required.
Not breaking, so it can happen without notice:
- adding a field, a parameter, an error code or an endpoint;
- changing the wording of an error
message; - better results for the same request.
Write your client to ignore fields it does not know, and to branch on the error code, never on the message.
SDK versions
SDKs use semantic versioning with beta tags: the first release is 0.1.0-beta.1. Version 1.0.0 will be the first GA
release.
Coverage
Beta does not mean full coverage. Roads and routing cover all of Nigeria once the Nigeria release is deployed (built, not live yet). Street names, places, stops and gates are most detailed in Lagos.
Attribution
Every label, Alpha included, keeps the same rule: show "© Rana Maps © OpenStreetMap" with our map or our data.