Edited at

apiblueprint のパラメーター内の記述で "-"(ハイフン) を使うとき

More than 1 year has passed since last update.

APIBlueprint を試しがてら使っているのですが、-(ハイフン)が入った値をパラメーターのサンプル値として設定するときに思ったような挙動をしなかったのでメモします。

+ Parameters 

+ sample1: sample1_val (string, optional) - サンプル1
+ sample2: sample2-val (string, optional) - サンプル2

みたいな記述をしたときに、 sample2 の方がなぜか reuired で出力されてしまいます。

これはどうも ハイフン が原因のようで、ハイフン を使うときは `(バッククォート)で括らないといかんみたいです。

なので、

+ Parameters 

+ sample1: sample1_val (string, optional) - サンプル1
+ sample2: `sample2-val` (string, optional) - サンプル2

とやれば大丈夫です。

リファレンスに書いてありそう。