derhuerst/vbb-rest

"Stations connected to" endpoint?

Open

#28 opened on Jun 5, 2018

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (13 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (142 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hey there,

Thanks so much for all the incredibly useful VBB libraries, and especially for running this REST API!

I wondered if you'd be interested in this API having an endpoint exposing the data in vbb-stations-connected-to – maybe at GET /stations/:id/connected-stations or similar.

I'm using the connected stations data in a single-page app and at the moment my only options are to 1. include the huge blob of data as JavaScript (very large, makes my app > 1 MB) or 2. run my own API exposing only this data, and have my app make requests to two different APIs.

I'd be up for doing the implementation if you don't have time. I just wanted to check here before doing any work on it. Maybe there are design/performance reasons why you don't want to do this, I'm not sure.

Contributor guide

Research direction
Study the existing API structure and implement a new endpoint that uses the vbb stations connected to package to return connected stations for a given station ID.
Tech stack
javascript
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptREST API basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70