Looking at updating the API docs for #12 it has become obvious that the docs don't properly describe the difference between "parameters" that are GET query string parameters and those that are actually POST/PUT data fields. The difference only becomes apparent when looking at the examples. We should define these separately in the docs and describe the difference in the intro.
Ideally where today we have 1 or 2 URLs and GET/POST/PUT/DELETE methods all described in one section, the docs should describe every URL and method separately. But this would be a complete rewrite of the document and I don't have time to do that right now.
[x] Decide on new terminology for query params vs form data
[x] Add intro section for GET params vs form data
[x] Update the API guide to separate the GET params from the form data
Looking at updating the API docs for #12 it has become obvious that the docs don't properly describe the difference between "parameters" that are GET query string parameters and those that are actually POST/PUT data fields. The difference only becomes apparent when looking at the examples. We should define these separately in the docs and describe the difference in the intro.
Ideally where today we have 1 or 2 URLs and GET/POST/PUT/DELETE methods all described in one section, the docs should describe every URL and method separately. But this would be a complete rewrite of the document and I don't have time to do that right now.