search

openfisca / openfisca-web-api

[DEPRECATED] Web API for OpenFisca
https://www.openfisca.fr/
GNU Affero General Public License v3.0
13 stars 11 forks source link

Remove "google styleguide" JSON data #41

Closed cbenz closed 7 years ago

cbenz commented 9 years ago

In general try to remove in the JSON output data that is already in the input.

In particular these keys: context, params, method, apiVersion

cbenz commented 9 years ago

@MattiSG what do you think about the removal of apiVersion keys?

MattiSG commented 9 years ago

That question is a bit vague ;)

I think it's always good to have some kind of reference to a description of the representation within the representation itself, for introspection. Thus, if apiVersion was an actually useful reference to some documented state of the code, it would be great to keep it. At the moment, though, I don't think proper versioning has been enforced in OpenFisca, and that piece of infirmation is thus misleading.

If versioning information was to be stored in the output data, then I don't think a single version number would fit. Considering OpenFisca's architecture, it would probably be an object with version identifiers for each of the parts (Core, Parsers, France, API), as a change in any of those can change the output. At least that's the consideration that made me create the submodule wrapper we use to ensure known stable points are reproducible.

MattiSG commented 7 years ago

Don't invest in the current endpoints if there's no user request.