データパック

上級者

選定ルール、命名パターン、リリース名のチェックを、あるインストールから別のインストールへコピーします。

データパックは、データだけが入った JSON ファイルです。コードの実行、アドレスからの取得、タイトルの追加、ユーザーの変更、メディアファイルの操作はできず、秘密の値を含めることもできません。

始める前に

オーナーであること。
admin スコープの API キーを持っていること。health_read、read、write のキーは拒否されます。
パックの JSON が手元にあること。受け取ったパックを使うか、「上級者向け」にある形式に沿って自分で書きます。

パックを移す

ルートはすべて http://your-server:6262 にあります。

パックを POST /api/v1/data-packs/validate に送ります。保存はせず、チェックだけを行います。"valid": true が表示されます。
同じ JSON を POST /api/v1/data-packs に送ります。パックは無効の状態で保存されます。この時点ではまだ何も変わりません。
GET /api/v1/data-packs を開くと、保存済みのパックが一覧表示されます。GET /api/v1/data-packs/{id} で 1 つをエクスポートできます。
ルールごとに pick_rule_id を 1 つずつ、naming_id を多くても 1 つ付けて、GET /api/v1/data-packs/{id}/preview を開きます。approval_hash が返ります。
同じ選択内容とそのハッシュを POST /api/v1/data-packs/{id}/apply に送ります。パックの id と、選んだルールの id が表示されます。

プレビュー:

GET /api/v1/data-packs/home-cinema/preview?pick_rule_id=balanced-web&naming_id=readable

適用のボディ:

{
  "pick_rule_ids": ["balanced-web"],
  "naming_id": "readable",
  "approval_hash": "the hash returned by preview"
}

適用で変わること

選んだ選定ルールは、それぞれ新しく作成されます。どのタイトルにも割り当てられません。
選んだ命名セットが置き換えるのは、次の設定だけです。
- 映画のファイルとフォルダーのパターン。
- 番組フォルダー、シーズンフォルダー、スペシャルフォルダー、エピソード、日付ベースの番組、アニメのパターン。
- アーティストフォルダー、アルバムフォルダー、ディスクフォルダー、曲、複数ディスクの曲のパターン。
- コロンと使用できない文字の書式。
- 複数エピソードの形式、放送日の形式、通し番号の桁数。
インポート時の名前変更、フォルダーの動作、タグの読み取り、スキャンの上限は、パックには決して含まれません。

うまくいかないとき

症状: 適用時に、プレビューが古いと表示されます。 原因: プレビューのあとに、パック、名前が重複する選定ルール、または置き換えられる命名設定のいずれかが変わりました。何も適用されていません。 対処: もう一度プレビューし、新しいハッシュを送ります。

症状: インポート時に、パックがすでに存在すると表示されます。 原因: パックが上書きされることはありません。 対処: 新しいパックに別の id を付けます。

症状: 権限エラーになります。 原因: キーが、オーナーが作成した admin キーではありません。 対処: オーナーとして admin キーを作成し、それを使います。

上級者向け

上限と拒否される条件

上限	値
`format`	`holyarrs-data-pack`
`version`	`1`
パックまたはエクスポートのサイズ	256 KiB
選定ルール	32
命名セット	8
リリース名のチェック	256
id	1 から 64 文字。小文字の英字、数字、ドット、ハイフン、アンダースコアが使えます。先頭と末尾は英字か数字にします
適用リクエストのボディ	16 KiB

パックは、重複したフィールドや不明なフィールド、末尾のあとに続く余分な JSON、不明な品質名や特性名、正しくない命名用の語、1 以外のバージョン、これらの上限を超える値がある場合に拒否されます。リリース名のチェックはそれぞれ HolyArrs のパーサーにかけられ、期待する項目すべてに一致する必要があります。

パックの形式

フィールド	内容
`format`, `version`, `id`, `name`	必須のヘッダー
`pick_rules`	それぞれに `id`、`name`、`kinds`、`rules`(段階、特性、サイズの上限、プロトコル、言語、順序)があります
`naming`	それぞれに `id`、`name`、`patterns`(上に挙げた命名設定)があります
`release_tests`	それぞれに `id`、`name`、`release_name`、`hints`、`expected`(種類、品質、解像度、ソース、コーデック、フラグ)があります

ルートとレスポンス

ルート	成功	拒否
`POST /api/v1/data-packs/validate`	200。`valid` と要約を返します	400 無効、413 大きすぎる
`POST /api/v1/data-packs`	201。要約を返し、ステータスは `inactive` です	409 id が存在する、400、413
`GET /api/v1/data-packs`	200。`data_packs` を返します
`GET /api/v1/data-packs/{id}`	200。パックの JSON を返します	404
`GET /api/v1/data-packs/{id}/preview`	200。`approval_hash` を返します	`pick_rule_id` と `naming_id` 以外のクエリがあると 400、404
`POST /api/v1/data-packs/{id}/apply`	200。`pack_id`、`pick_rule_ids`、`naming_id` を返します	409 古い、400、404