テスト API¶
注意
テスト API はテスト目的のためだけに利用してください
概要¶
テスト API は意図的に発生させるのが難しい状況を API 経由で発生させるための API です。
注意¶
テスト API は利便性を最優先にするため破壊的変更を積極的に行います。
GenerateCrashLog¶
- x-sora-target:
Sora_20380119.GenerateCrashLog
意図的に Sora のクラッシュログを発生させます。クラッシュログの監視のテストなどに利用してください。
キー |
型 |
---|---|
info |
object |
$ http POST 127.0.0.1:3000/ x-sora-target:Sora_20380119.GenerateCrashLog \
info:='{"spam": "egg"}' \
-vvv
FailArchive¶
- x-sora-target:
Sora_20380119.FailArchive
意図的に Sora の録画を失敗させます。 archive.failed
ウェブフックを意図的に出力させたい場合に利用してください。
テストの利便性を考えランダムな値である connection_id
ではなく、固定値として設定できる client_id
を指定できるようにしています。
client_id
は指定しなければ connection_id
が設定されるので、
client_id
を指定しない場合、 client_id
に connection_id
を指定しても動作します。
キー |
型 |
---|---|
channel_id |
string |
client_id |
string |
$ http POST 127.0.0.1:3000/ x-sora-target:Sora_20380119.FailArchive \
channel_id=sora \
client_id=test \
-vvv