Dátové balíky

Skopíruj svoje pravidlá výberu, vzory pomenovania alebo kontroly názvov releasov z jednej inštalácie do druhej.

Dátový balík je súbor JSON iba s údajmi. Nevie spustiť kód, načítať adresu, pridať titul, zmeniť používateľa, siahnuť na mediálne súbory ani niesť tajné údaje.

Skôr než začneš

• Si vlastník.
• Máš kľúč API s rozsahom admin. Kľúče s health_read, read alebo write sa odmietnu.
• Máš JSON balíka. Použi balík, ktorý si dostal, alebo si napíš vlastný podľa tvaru v sekcii Pre expertov.

Presuň balík

Všetky cesty sú na http://your-server:6262.

1. Pošli balík na POST /api/v1/data-packs/validate. Skontroluje ho bez uloženia. Mal by si vidieť "valid": true.
2. Pošli ten istý JSON na POST /api/v1/data-packs. Uloží balík ako neaktívny. Zatiaľ sa nič nemení.
3. Otvor GET /api/v1/data-packs a vypíš uložené balíky. GET /api/v1/data-packs/{id} jeden vyexportuje.
4. Otvor GET /api/v1/data-packs/{id}/preview s jedným pick_rule_id na každé pravidlo a najviac jedným naming_id. Dostaneš approval_hash.
5. Pošli ten istý výber a hash na POST /api/v1/data-packs/{id}/apply. Mal by si vidieť id balíka a id pravidiel, ktoré si vybral.

Náhľad:

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

Telo pre apply:

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

Upozornenie

Sada pomenovania nahradí tvoje aktuálne vzory pomenovania. Existujúce súbory sa nepremenujú.

Čo použitie zmení

• Každé vybrané pravidlo výberu sa vytvorí nové. Nie je priradené žiadnemu titulu.
• Vybraná sada pomenovania nahradí iba tieto nastavenia:
  • Vzory súborov a priečinkov filmov.
  • Vzory priečinka seriálu, priečinka série, priečinka špeciálov, epizódy, denné a anime.
  • Vzory priečinka interpreta, priečinka albumu, priečinka disku, skladby a skladby na viacerých diskoch.
  • Formátovanie dvojbodky a nepovolených znakov.
  • Štýl viacerých epizód, štýl dátumu vysielania a počet číslic absolútneho čísla.
• Premenovanie pri importe, správanie priečinkov, čítanie tagov a limity skenovania nikdy nie sú v balíku.

Ak to nefunguje

Príznak: Apply hlási, že náhľad je neaktuálny. Príčina: po náhľade sa zmenil balík, názov pravidla výberu, ktorý by sa zrazil, alebo nastavenie pomenovania, ktoré by sa nahradilo. Nič sa nepoužilo. Riešenie: vytvor náhľad znova a pošli nový hash.

Príznak: import hlási, že balík už existuje. Príčina: balíky sa nikdy nenahrádzajú. Riešenie: daj novému balíku iné id.

Príznak: chyba oprávnenia. Príčina: kľúč nie je kľúč admin vytvorený vlastníkom. Riešenie: vytvor ako vlastník kľúč admin a použi ho.

Pre expertov

Limity a odmietnutia

Limit	Hodnota
format	holyarrs-data-pack
version	1
Veľkosť balíka alebo exportu	256 KiB
Pravidlá výberu	32
Sady pomenovania	8
Kontroly názvov releasov	256
Id	1 až 64 znakov: malé písmená, číslice, bodky, pomlčky, podčiarkovníky. Začínajú a končia písmenom alebo číslicou
Telo požiadavky apply	16 KiB

Balík sa odmietne pre duplicitné alebo neznáme polia, JSON navyše za koncom, neznáme názvy kvality alebo vlastností, zlé slová pomenovania, verziu inú než 1 alebo hodnoty za týmito limitmi. Každá kontrola názvu releasu prejde cez parser HolyArrs a musí sa zhodovať s každým faktom, ktorý očakáva.

Tvar balíka

Pole	Obsahuje
format, version, id, name	Povinná hlavička
pick_rules	Každé má id, name, kinds a rules (stupne, vlastnosti, limity veľkosti, protokol, jazyk, poradie)
naming	Každé má id, name a patterns (nastavenia pomenovania uvedené vyššie)
release_tests	Každé má id, name, release_name, hints a expected (druh, kvalita, rozlíšenie, zdroj, kodek, príznaky)

Cesty a odpovede

Cesta	Úspech	Odmietnutie
POST /api/v1/data-packs/validate	200 s valid a súhrnom	400 neplatné, 413 príliš veľké
POST /api/v1/data-packs	201 so súhrnom, 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íka	404
GET /api/v1/data-packs/{id}/preview	200 s approval_hash	400 pre každý dotaz iný než pick_rule_id a naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 s pack_id, pick_rule_ids, naming_id	409 neaktuálne, 400, 404

Súvisiace stránky

• Metadáta
• Knižnica