public-transport/friendly-public-transport-format

write schema files

Open

#64 opened on Oct 28, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees) (3 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

Using e.g. JSON schemas, one can effortlessly a) verify that a piece of data adheres to the schema and b) generate types for statically typed languages.

This would help with the adoption of FPTF. Probably it makes sense to wait for #61 to start working on this though.

Contributor guide

Research direction
Study the FPTF format specification and write JSON schema files that validate the data structure. Note that this issue is blocked by #61, so first understand the outcome of that issue.
Tech stack
None
Domain
apibackenddata
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.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JSON SchemaFPTF format knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70