パラメーターは、特定の情報や値を受け取るためにエンドポイントへ渡すオプションです。
デフォルト、最小、最大
Name: コードスニペットとして整形したパラメーター名です。
Data type: パラメーターが string、integer、boolean、object、array のどれかを示します。
Description: パラメーターの役割を説明します。string、integer、object、array には名詞句を使います。boolean には動詞を使います。説明の末尾は句点にします。
Required status: パラメーターが必須かどうかを示します。
Constraints: パラメーターのデフォルト、最小、最大の値を列挙します。
タイトルと説明を書くときは、ボイスとトーンを意識します。簡潔に書き、読者の技術レベルがさまざまであることを忘れないでください。
deviceName のように事実を述べる説明は、動詞で始めにくいことがあります。動詞で始めると自然なパラメーターもあります。この違いは問題ありません。
受動態は避け、パラメーターの役割や用途を、読者が理解できる短い文で説明します。
参考として、パラメーター説明の例を示します。
deviceName: デバイス名。
version: Cloudflare One クライアントのバージョン。
per_page: リクエストする結果の最大件数を設定します。
enabled: ロードバランサーを有効または無効にします。
ASN: プレフィックスの広報に使う自律システム番号（ASN）。
Name: actor.ip
Data type: string
Description: 特定の IP アドレスまたは有効な CIDR 範囲でリクエストを絞り込みます。
Required status: 必須ではない
Values: デフォルト、最小、最大の記載はありません。