cognitect-labs / vase

Data driven microservices

Eclipse Public License 1.0

374 stars 40 forks source link

Document parameter defaults #59

Open ddeaguiar opened 7 years ago

ddeaguiar commented 7 years ago

Description

Let's make this more visible in the docs.

ddeaguiar commented 7 years ago

A recent commit adds a note regarding default parameters in the Handling Parameters section of the Your First API guide but I still think we should include this documentation elsewhere as well. Perhaps the Action Literals document?

ohpauleez commented 7 years ago

Default parameters were added in the lastest evolution of Vase, which is why the documentation is light. I agree, we should mention it in the docs (the samples and tests illustrate it)

mtnygard commented 7 years ago

I think we should add a new doc that is all about parameters. There is more subtlety that we should cover:

Dealing with namespaced names from JSON
The order of merging params. Who wins if there is a query-param, a path-param, and a body-param with the same key?
The role of edn-coerce.