エンドポイント
エンドポイントはHTTPSリクエストを行うために使用され、GET、POST、PUT、PATCH、およびDELETEメソッドはリソースとのインタラクション方法を決定します。
タイトル: 文の形式（最初の単語が大文字）を使用したエンドポイントのタイトル。タイトルの末尾には句読点を使用しません。単純なケースは通常、以下のいずれかの形式を取ります：
単一のアイテムに対して作用する/返すエンドポイント：動詞 + 不定冠詞 + 単数リソース名。
- 例：リストアイテムを取得
アイテムのコレクションに対して作用する/返すエンドポイント：動詞 + 複数リソース名。
- 例：リストアイテムを取得
説明: エンドポイントが何をするか、またはどのように使用されるべきかを説明します。説明の末尾には句読点を使用してください。
プランの可用性: エンドポイントを使用するために必要なプランをリストします（例：Free、Pro、Business、Enterprise）。
メソッド: GET、POST、PUT、PATCH、またはDELETEなどのメソッドの種類を含みます。
エンドポイント: エンドポイントをリストし、コードスニペットとしてスタイライズする必要があります。
エンドポイントが指定された期間内に非推奨になるが、まだ利用可能な場合は、エンドポイントの説明に非推奨に関する注意を追加します（「<エンドポイント名>は<年、月、日>に非推奨になります。代わりに<代替エンドポイント>を使用してください」）。詳細については、非推奨APIを参照してください。
必要な権限: エンドポイントを使用するために必要なユーザーレベルの追加権限。
タイトルと説明を書く際には、私たちの声とトーンを念頭に置いてください。簡潔にし、ユーザーがさまざまな技術レベルから来ていることを忘れないでください。また、できるだけ能動態で書くことで、ロボットのように聞こえず、情報を理解しやすくします。
以下は、参考のためのエンドポイントのタイトルと説明のいくつかの例です：
- ドメインを取得: 単一のドメインを取得します。
- ワーカーをリスト: アップロードされたワーカーのリストを取得します。
- プールをリスト: 設定されたプールをリストします。
- 待機室を作成: 新しい待機室を作成します。
- ヘルスチェックを更新: 設定されたヘルスチェックを更新します。
タイトル: ユーザー監査ログを取得
説明: ユーザーアカウントの監査ログのリストを取得します。
プランの可用性: Free、Pro、Business、Enterprise
メソッド: GET
エンドポイント: user/audit_logs