public-transport/friendly-public-transport-format

indicating information up-to-dateness

Open

#43 opened on Jul 27, 2018

View on GitHub
 (6 comments) (1 reaction) (0 assignees) (3 forks)github user discovery
breaking-changedesignenhancementhelp wanted

Repository metrics

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

Description

I think it would make sense to introduce an attribute to FPTF@2 objects that indicates the up-to-dateness of the given information. This would enable us (e.g.) to provide a combination of static and realtime data in FPTF (where more up-to-date information overwrites older information).

Such an attribute could for example be called asOf, effective or updated and would contain a date string. It could also be required since this information is basically almost always available, as far as I know?

Opinions?

Contributor guide

Research direction
Review the current FPTF@2 specification to understand existing object fields, then propose a specific attribute (e.g., `updated`) with a date string value. Consider whether to make it required and how it interacts with realtime data.
Tech stack
None
Domain
apidata
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
FPTF
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80