I would like to define options for Apiary parameters, I'm currently listing them in the description:
m
(optional, string, m
) ... measurement e.g. m = meters, km = kilometers, yd = yards, mi = milesYou can enumerate the possible values of an URI query parameter and discuss it in the parameter discussion like so:
+ Parameters
+ measurement = `m` (optional, string) ... measurement units
Any discussion here...
e.g. explanation of **values** listed bellow are.
+ Values
+ `m`
+ `mi`
+ `yd`
Also see the Documenting query parameters with API Blueprint question.
You can define the optional parameters in the endpoint as below:
/api/data{?measurement}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With