パラメータ
パラメータは、特定の情報や値を受け取るためにエンドポイントに渡されるオプションです。
デフォルト、最小、および最大
名前: コードスニペットとしてフォーマットされたパラメータの名前。
データ型: パラメータが文字列、整数、ブール値、オブジェクト、または配列であるかを示します。
説明: パラメータの機能を説明します。文字列、整数、オブジェクト、配列には名詞句を使用し、ブール値には動詞を使用します。説明はピリオドで終わります。
必須ステータス: パラメータが必須かどうかを示します。
制約: パラメータのデフォルト、最小、または最大値をリストします。
タイトルや説明を書く際には、私たちの声とトーンを念頭に置いてください。簡潔にし、ユーザーがさまざまな技術レベルから来ていることを忘れないでください。
一部のパラメータの説明はより事実に基づいており、deviceNameのように動詞で始めるのは意味がありません。他のパラメータは動詞で始めるのが適しており、この違いは問題ありません。
受動態を避け、パラメータが何をするのか、または何に使用されるのかをユーザーが理解できる簡潔な文で説明することを目指してください。
以下は、参考のためのパラメータ説明のいくつかの例です：
deviceName: デバイス名。
version: WARPクライアントのバージョン。
per_page: リクエストされた結果の最大数を設定します。
enabled: ロードバランサーを有効または無効にします。
ASN: プレフィックスを広告するために使用される自律システム番号（ASN）。
名前: actor.ip
データ型: string
説明: 特定のIPアドレスまたは有効なCIDR範囲でリクエストをフィルタリングします。
必須ステータス: 必須ではありません
値: リストされたデフォルト、最小、または最大値はありません。