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

Document API routes #72

Closed fpagnoux closed 7 years ago

cbenz commented 7 years ago

Cf https://github.com/openfisca/openfisca-gitbook/commit/65a680cabbb50b7656e8858d26685b9014c8c72e

There are no more TODOs in https://doc.openfisca.fr/openfisca-web-api/endpoints.html

I removed the deprecated features.

fpagnoux commented 7 years ago

Nice, thanks @cbenz !

Can we thus close the issue ?

cbenz commented 7 years ago

@fpagnoux Did you find it useful for a newcomer?

I did not put as much details as I would have liked to describe the output of the entities endpoint. There are many cases, roles, subroles, max counts, which I think are understood by mastering the concept of entity.

I close this issue because it was about documenting the endpoints, but I'm OK to open new ones later.

fpagnoux commented 7 years ago

I think it was the good level of investment.

It brings information that is useful to the users, and help them figure out which route they should use. I'm sure we could do better, but I would only do it after rethinking the api routes.