public-transport / friendly-public-transport-format

A format for APIs, libraries and datasets containing and working with public transport data.
Creative Commons Attribution Share Alike 4.0 International
125 stars 1 forks source link

Specification for API is missing #67

Closed DmitriyBobrovskiy closed 3 years ago

DmitriyBobrovskiy commented 3 years ago

It would be great if there is specification how API should look like and what methods there should be to comply to FPTF format. I think methods from this repo are fine to start with.

derhuerst commented 3 years ago

By design, we omitted an API specification from FPTF because it is supposed to

This is why I (personally) think that including API specifications in the FPTF repo will make it a bit harder to understand and adopt.

But with the goal explained by you, @juliuste created the FPTI JS API: A specified common set of API calls that builds on top of FPTF. Let's evolve this spec and expand it to other languages and environments!

DmitriyBobrovskiy commented 3 years ago

I understand why You don't want to include API specification and that's fine, in my opinion. But it can be done in more transparent way by adding reference to FPTI JS API, because it took for me some time to find it. And I absolutely agree that it should be expanded to other languages.