Datové balíčky

Zkopíruj svá pravidla výběru, vzory pojmenování nebo kontroly názvů releasů z jedné instalace do druhé.

Datový balíček je soubor JSON, který obsahuje jen data. Nemůže spouštět kód, načítat adresu, přidat titul, měnit uživatele, sahat na mediální soubory ani nést tajné údaje.

Než začneš

• Jsi vlastník.
• Máš API klíč s rozsahem admin. Klíče s health_read, read nebo write se odmítnou.
• Máš JSON balíčku. Použij balíček, který jsi dostal, nebo si napiš vlastní podle tvaru v sekci Pro pokročilé.

Přenes balíček

Všechny trasy jsou na http://your-server:6262.

1. Pošli balíček na POST /api/v1/data-packs/validate. Zkontroluje ho bez uložení. Měl bys vidět "valid": true.
2. Pošli stejný JSON na POST /api/v1/data-packs. Uloží balíček jako neaktivní. Zatím se nic nemění.
3. Otevři GET /api/v1/data-packs a uvidíš uložené balíčky. GET /api/v1/data-packs/{id} jeden z nich exportuje.
4. Otevři GET /api/v1/data-packs/{id}/preview s jedním pick_rule_id pro každé pravidlo a nejvýš jedním naming_id. Dostaneš approval_hash.
5. Pošli stejnou volbu a hash na POST /api/v1/data-packs/{id}/apply. Měl bys vidět id balíčku a id pravidel, která sis vybral.

Náhled:

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

Tělo pro použití:

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

Upozornění

Sada pojmenování nahradí tvoje současné vzory pojmenování. Existující soubory se nepřejmenují.

Co použití změní

• Každé vybrané pravidlo výběru se vytvoří znovu. Není přiřazené žádnému titulu.
• Vybraná sada pojmenování nahradí jen tato nastavení:
  • Vzory souborů a složek filmů.
  • Vzory složky seriálu, složky řady, složky speciálů, epizody, denních dílů a anime.
  • Vzory složky umělce, složky alba, složky disku, skladby a skladby na více discích.
  • Formátování dvojteček a nepovolených znaků.
  • Styl více epizod, styl data vysílání a počet číslic absolutního čísla.
• Přejmenování při importu, chování složek, čtení tagů a limity skenování nikdy v balíčku nejsou.

Když to nefunguje

Příznak: použití hlásí, že náhled je zastaralý. Příčina: po náhledu se změnil balíček, název pravidla výběru, který by se střetl, nebo nastavení pojmenování, které by se nahradilo. Nic se nepoužilo. Řešení: udělej náhled znovu a pošli nový hash.

Příznak: import hlásí, že balíček už existuje. Příčina: balíčky se nikdy nenahrazují. Řešení: dej novému balíčku jiné id.

Příznak: chyba oprávnění. Příčina: klíč není klíč admin vytvořený vlastníkem. Řešení: vytvoř jako vlastník klíč admin a použij ho.

Pro pokročilé

Limity a odmítnutí

Limit	Hodnota
format	holyarrs-data-pack
version	1
Velikost balíčku nebo exportu	256 KiB
Pravidla výběru	32
Sady pojmenování	8
Kontroly názvů releasů	256
Id	1 až 64 znaků: malá písmena, číslice, tečky, pomlčky, podtržítka. Začínají a končí písmenem nebo číslicí
Tělo požadavku na použití	16 KiB

Balíček se odmítne kvůli duplicitním nebo neznámým polím, dalšímu JSON za koncem, neznámým názvům kvality nebo vlastností, špatným slovům pojmenování, jiné verzi než 1 nebo hodnotám přes tyto limity. Každá kontrola názvu releasu projde parserem HolyArrs a musí odpovídat každému údaji, který očekává.

Tvar balíčku

Pole	Obsahuje
format, version, id, name	Povinná hlavička
pick_rules	Každé má id, name, kinds a rules (stupně, vlastnosti, limity velikosti, protokol, jazyk, pořadí)
naming	Každé má id, name a patterns (výše uvedená nastavení pojmenování)
release_tests	Každé má id, name, release_name, hints a expected (druh, kvalita, rozlišení, zdroj, kodek, příznaky)

Trasy a odpovědi

Trasa	Úspěch	Odmítnutí
POST /api/v1/data-packs/validate	200 s valid a souhrnem	400 neplatné, 413 příliš velké
POST /api/v1/data-packs	201 se souhrnem, stav inactive	409 id existuje, 400, 413
GET /api/v1/data-packs	200 s data_packs
GET /api/v1/data-packs/{id}	200 s JSON balíčku	404
GET /api/v1/data-packs/{id}/preview	200 s approval_hash	400 pro jakýkoli dotaz kromě pick_rule_id a naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 s pack_id, pick_rule_ids, naming_id	409 zastaralé, 400, 404

Související

• Metadata
• Knihovna