Specification for API is missing
DmitriyBobrovskiy opened this issue · 2 comments
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.
By design, we omitted an API specification from FPTF because it is supposed to
- be a simple & compact standard – There are many standards that bundle a data format, semantic definitions of fields and a protocol, and often adopting them is a big effort.
- work without any API, e.g. static files containing FPTF-formatted data.
- work in environments where APIs don't necessarily work like RPC calls, e.g. HTTP REST APIs.
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!
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.