search

mozilla / aestimia

[Archived] Assessment tool
4 stars 10 forks source link

Document the API #26

Closed toolness closed 11 years ago

toolness commented 11 years ago

The /demo page goes a long way to helping folks understand the API through playing with it, but we should formally document it too.

toolness commented 11 years ago

I added some docs in 74d0367c81dcce7d190c219650f17704685aa6de, though I'd still like to add more.

toolness commented 11 years ago

Added more in d2958ff010c4a51b1a2263185fec8cdd24970b6f. I think all that's really left now is to fully document the submission schema.

toolness commented 11 years ago

By the way, the latest docs can be viewed at http://secret-ravine-6803.herokuapp.com/demo. I'm adding it there partly so the docs stay in-sync with the code, and partly because I'd like to have the "play with the api" ui as close to the docs as possible.

toolness commented 11 years ago

The API secret for the URL above is lol, by the way.

toolness commented 11 years ago

This is done!