Dashboard ext info api docs

geosoco commented 11 years ago

initial merge of the summary info docs.

(Summary_info is a terrible name and we've agreed to change it, but no idea what to change it to at the moment)

geosoco commented 11 years ago

@katiek @michaelbrooks . Please review this initial set of doc submits.

michaelbrooks commented 11 years ago

Looking good overall. Sorry to nit-pick, but only the required parameters should be bold. The rest should be normal.

I think what we decided this afternoon is to keep "codes", "user", and "participant" as the top-level division here instead of switching it up. That's fine, but I'd propose we remove the "summary_info" segment and change the urls this way:

/ext/summary_info/codes/applied_counts -> /ext/code_summary/applied_counts (notice I also changed from plural to singular)
/ext/summary_info/user/message_application -> /ext/user_summary/message_application
/ext/summary_info/participant/hourofday_counts -> /ext/participant_summary/hourofday_counts

etc...

I also suggest removing /ext/ from all of the urls. That will be implied by this being within the Extended API, and is explained on the top-level api page.

geosoco commented 11 years ago

I think all of these should be fixed now.

michaelbrooks commented 11 years ago

Looks good to me. We'll rebase these off of master and then do a new pull request.

etcgroup / text-prizm

Dashboard ext info api docs #65