roadquality 0.0.11

Crowd-sourced road quality data

  • Contact: N/A
  • License: N/A

Resources

mapRoute

Operations

Method and Path Description
GET /mapRoutes
GET /mapRoutes/snap
POST /mapRoutes

segment

Operations

Method and Path Description
GET /segments

Search all segments

GET /segments/boundingbox

Search all segments within a bounding box

POST /segments
PUT /segments

segmentRating

Operations

Method and Path Description
GET /segmentRatings
DELETE /segmentRatings

user

Operations

Method and Path Description
GET /users
PUT /users
DELETE /users

versionInfo

Operations

Method and Path Description
GET /info

Headers

No headers

Imports

No imports

Enums

pathType

The level of dedication of the segment to cycling

shared

A shared road for cars and bikes (road shoulder)

dedicatedLane

A dedicated bike lane on the road

bikePath

A completely isolated bike lane (a natural barrier from road traffic)

surfaceType

The surface type of a segment (road type)

gravel

Road consisting of small rocks

asphalt

Road consisting of paved asphalt

dirt

Road consisting of cleared dirt

userRole

The type of user (user or admin)

user

A standard consumer of the service

admin

An administrator of the application

Models

mapRoute

Example Json: Minimal | Full

A routable path on a map - not necessarily a segment

Field Type Required? Default Description
polyline string Yes -

distance double Yes -

point

Example Json: Minimal | Full

A longitudinal or latitudinal coordatine

Field Type Required? Default Description
lat double Yes -

lng double Yes -

segment

Example Json: Minimal | Full

A segment of road which will be rated and tagged

Field Type Required? Default Description
id uuid Yes -

name string No -

description string No -

polyline string Yes -

created_by uuid Yes -

The user who created the segment

segmentCreateForm

Example Json: Minimal | Full

Form the client uses to create a segment

Field Type Required? Default Description
name string No -

description string No -

polylines [string] Yes -

surfaceRating integer Yes -

trafficRating integer Yes -

surface surfaceType Yes -

pathType pathType Yes -

segmentRating

Example Json: Minimal | Full

A rating that is supplied with the segment

Field Type Required? Default Description
id uuid Yes -

segmentId uuid Yes -

userId uuid Yes -

trafficRating integer Yes -

surfaceRating integer Yes -

surface surfaceType Yes -

pathType pathType Yes -

createdAt date-time-iso8601 Yes -

updatedAt date-time-iso8601 Yes -

deletedAt date-time-iso8601 No -

segmentUpdateForm

Example Json: Minimal | Full

Form to modify an existing segment

Field Type Required? Default Description
name string No -

description string No -

surfaceRating integer No -

trafficRating integer No -

surface surfaceType No -

pathType pathType No -

user

Example Json: Minimal | Full

A user of the service

Field Type Required? Default Description
id uuid Yes -

firstName string Yes -

lastName string Yes -

email string Yes -

city string No -

province string No -

country string No -

birthdate date-time-iso8601 No -

sex string No -

role userRole Yes -

stravaToken string Yes -

Strava API token

createdAt date-time-iso8601 Yes -

updatedAt date-time-iso8601 Yes -

deletedAt date-time-iso8601 No -

userUpdateForm

Example Json: Minimal | Full

A form to update attributes about a user

Field Type Required? Default Description
birthdate date-time-iso8601 No -

sex string No -

versionInfo

Example Json: Minimal | Full
Field Type Required? Default Description
name string Yes -

Name of this service

version string Yes -

Version of this service

scalaVersion string Yes -

Version of Scala used to build this service

sbtVersion string Yes -

Version of SBT used to build this service

Unions

No unions