Adatcsomagok

Másold át a választási szabályaidat, az elnevezési mintáidat vagy a Release-nevek ellenőrzéseit egyik telepítésről a másikra.

Az adatcsomag egy JSON-fájl, amely csak adatot tartalmaz. Nem futtathat kódot, nem kérhet le címet, nem adhat hozzá címet, nem módosíthat felhasználót, nem érinthet médiafájlokat, és nem hordozhat titkokat.

Mielőtt elkezdenéd

• Te vagy a tulajdonos.
• Van admin hatókörű API-kulcsod. A health_read, read vagy write hatókörű kulcsokat elutasítja.
• Megvan a csomag JSON-ja. Használd a kapott csomagot, vagy írj egyet a Haladóknak alatti szerkezet alapján.

Csomag átmozgatása

Minden útvonal a http://your-server:6262 címen érhető el.

1. Küldd el a csomagot a POST /api/v1/data-packs/validate útvonalra. Mentés nélkül ellenőrzi. A "valid": true értéket kell látnod.
2. Küldd el ugyanazt a JSON-t a POST /api/v1/data-packs útvonalra. Inaktívként menti a csomagot. Egyelőre semmi sem változik.
3. A mentett csomagok listájához nyisd meg a GET /api/v1/data-packs útvonalat. A GET /api/v1/data-packs/{id} egyet exportál.
4. Nyisd meg a GET /api/v1/data-packs/{id}/preview útvonalat szabályonként egy pick_rule_id értékkel és legfeljebb egy naming_id értékkel. Egy approval_hash értéket kapsz.
5. Küldd el ugyanezt a választást és a hash-t a POST /api/v1/data-packs/{id}/apply útvonalra. A csomag azonosítóját és a kiválasztott szabályok azonosítóit kell látnod.

Előnézet:

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

Az apply kérés törzse:

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

Figyelem

Az elnevezési készlet lecseréli a jelenlegi elnevezési mintáidat. A meglévő fájlok nem lesznek átnevezve.

Mit változtat a csomag alkalmazása

• Minden kiválasztott választási szabály újként jön létre. Egyetlen címhez sincs hozzárendelve.
• A kiválasztott elnevezési készlet csak ezeket a beállításokat cseréli le:
  • A film fájl- és mappamintái.
  • A sorozat mappa-, évadmappa-, különleges epizódok mappa-, epizód-, napi és anime mintái.
  • Az előadó mappa-, album mappa-, lemezmappa-, szám- és többlemezes szám mintái.
  • A kettőspont és a tiltott karakterek formázása.
  • A többepizódos stílus, a megjelenési dátum stílusa és az abszolút szám számjegyei.
• Az átnevezés importáláskor, a mappák viselkedése, a címkék olvasása és a szkennelési korlátok soha nem szerepelnek csomagban.

Ha nem működik

Tünet: az apply szerint az előnézet elavult. Ok: az előnézet óta megváltozott a csomag, egy ütköző választási szabály neve, vagy egy lecserélendő elnevezési beállítás. Semmi sem lett alkalmazva. Megoldás: nézd meg újra az előnézetet, és küldd el az új hash-t.

Tünet: az importálás szerint a csomag már létezik. Ok: a csomagokat soha nem írja felül. Megoldás: adj az új csomagnak másik azonosítót.

Tünet: jogosultsági hiba. Ok: a kulcs nem a tulajdonos által készített admin kulcs. Megoldás: tulajdonosként készíts admin kulcsot, és azt használd.

Haladóknak

Korlátok és elutasítások

Korlát	Érték
format	holyarrs-data-pack
version	1
Egy csomag vagy export mérete	256 KiB
Választási szabályok	32
Elnevezési készletek	8
Release-nevek ellenőrzései	256
Azonosítók	1–64 karakter: kisbetűk, számjegyek, pontok, kötőjelek, aláhúzások. Betűvel vagy számjeggyel kezdődnek és végződnek
Az apply kérés törzse	16 KiB

A HolyArrs elutasítja a csomagot, ha duplikált vagy ismeretlen mezőt tartalmaz, ha a vége után még JSON van, ha ismeretlen minőség- vagy ismertetőjegy-nevet, hibás elnevezési szavakat vagy 1-től eltérő verziót tartalmaz, vagy ha az értékek túllépik ezeket a korlátokat. Minden Release-név-ellenőrzés átfut a HolyArrs elemzőjén, és minden várt tényezőnek egyeznie kell.

A csomag szerkezete

Mező	Mit tartalmaz
format, version, id, name	Kötelező fejléc
pick_rules	Mindegyiknek van id, name, kinds és rules mezője (lépések, ismertetőjegyek, méretkorlátok, protokoll, nyelv, sorrend)
naming	Mindegyiknek van id, name és patterns mezője (a fent felsorolt elnevezési beállítások)
release_tests	Mindegyiknek van id, name, release_name, hints és expected mezője (kind, quality, resolution, source, codec, flags)

Útvonalak és válaszok

Útvonal	Siker	Elutasítás
POST /api/v1/data-packs/validate	200, valid értékkel és összegzéssel	400 érvénytelen, 413 túl nagy
POST /api/v1/data-packs	201 összegzéssel, inactive állapottal	409 az azonosító létezik, 400, 413
GET /api/v1/data-packs	200 data_packs értékkel
GET /api/v1/data-packs/{id}	200 a csomag JSON-jával	404
GET /api/v1/data-packs/{id}/preview	200 approval_hash értékkel	400 minden, a pick_rule_id és naming_id értéken kívüli lekérdezésre, 404
POST /api/v1/data-packs/{id}/apply	200 pack_id, pick_rule_ids, naming_id értékkel	409 elavult, 400, 404

Kapcsolódó oldalak

• Metaadatok
• Médiatár