Duomenų paketai

Perkelk savo parinkimo taisykles, pavadinimų šablonus ar release pavadinimų patikras iš vieno diegimo į kitą.

Duomenų paketas yra JSON failas, kuriame yra tik duomenys. Jis negali vykdyti kodo, atsisiųsti adreso turinio, pridėti pavadinimo, keisti naudotojo, liesti medijos failų ar nešti paslapčių.

Prieš pradedant

• Tu esi savininkas.
• Turi API raktą su admin apimtimi. Raktai su health_read, read ar write atmetami.
• Turi paketo JSON. Naudok gautą paketą arba parašyk savo pagal formą, pateiktą skyriuje Pažengusiems.

Paketo perkėlimas

Visi maršrutai yra adresu http://your-server:6262.

1. Nusiųsk paketą į POST /api/v1/data-packs/validate. Jis patikrina neišsaugodamas. Turėtum pamatyti "valid": true.
2. Nusiųsk tą patį JSON į POST /api/v1/data-packs. Jis išsaugo paketą kaip neaktyvų. Kol kas niekas nekeičiama.
3. Atidaryk GET /api/v1/data-packs, kad pamatytum išsaugotus paketus. GET /api/v1/data-packs/{id} eksportuoja vieną.
4. Atidaryk GET /api/v1/data-packs/{id}/preview su vienu pick_rule_id kiekvienai taisyklei ir ne daugiau kaip vienu naming_id. Gausi approval_hash.
5. Nusiųsk tą patį pasirinkimą ir hash į POST /api/v1/data-packs/{id}/apply. Turėtum pamatyti paketo id ir tavo pasirinktų taisyklių id.

Peržiūra:

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

Taikymo užklausos turinys:

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

Caution

Pavadinimų rinkinys pakeičia tavo dabartinius pavadinimų šablonus. Esami failai nepervadinami.

Ką pakeičia taikymas

• Kiekviena pasirinkta parinkimo taisyklė sukuriama nauja. Ji nepriskiriama jokiam pavadinimui.
• Pasirinktas pavadinimų rinkinys pakeičia tik šiuos nustatymus:
  • Filmo failo ir aplanko šablonus.
  • Serialo aplanko, sezono aplanko, specialiųjų epizodų aplanko, serijos, kasdienių epizodų ir anime šablonus.
  • Atlikėjo aplanko, albumo aplanko, disko aplanko, kūrinio ir kelių diskų kūrinio šablonus.
  • Dvitaškio ir neleistinų simbolių formatavimą.
  • Kelių serijų stilių, eterio datos stilių ir absoliutaus numerio skaitmenų skaičių.
• Pervadinimas importuojant, aplankų elgsena, žymų skaitymas ir skenavimo limitai niekada nėra pakete.

Jei neveikia

Požymis: taikymas sako, kad peržiūra pasenusi. Priežastis: po peržiūros pasikeitė paketas, parinkimo taisyklės pavadinimas, kuris sutaptų, arba pavadinimų nustatymas, kurį jis pakeistų. Niekas nebuvo pritaikyta. Sprendimas: peržiūrėk dar kartą ir nusiųsk naują hash.

Požymis: importas sako, kad paketas jau yra. Priežastis: paketai niekada nepakeičiami. Sprendimas: duok naujam paketui kitą id.

Požymis: teisių klaida. Priežastis: raktas nėra savininko sukurtas admin raktas. Sprendimas: kaip savininkas sukurk admin raktą ir naudok jį.

Pažengusiems

Limitai ir atmetimai

Limitas	Reikšmė
format	holyarrs-data-pack
version	1
Paketo ar eksporto dydis	256 KiB
Parinkimo taisyklės	32
Pavadinimų rinkiniai	8
Release pavadinimų patikros	256
Id	nuo 1 iki 64 simbolių: mažosios raidės, skaitmenys, taškai, brūkšneliai, pabraukimai. Prasideda ir baigiasi raide ar skaitmeniu
Taikymo užklausos turinys	16 KiB

Paketas atmetamas dėl pasikartojančių ar nežinomų laukų, papildomo JSON po pabaigos, nežinomų kokybės ar požymių pavadinimų, blogų pavadinimų žodžių, kitos nei 1 versijos arba reikšmių, viršijančių šiuos limitus. Kiekviena release pavadinimo patikra vykdoma per HolyArrs analizatorių ir turi atitikti kiekvieną laukiamą faktą.

Paketo forma

Laukas	Kas jame
format, version, id, name	Privaloma antraštė
pick_rules	Kiekviena turi id, name, kinds ir rules (žingsniai, požymiai, dydžio ribos, protokolas, kalba, tvarka)
naming	Kiekviena turi id, name ir patterns (aukščiau išvardyti pavadinimų nustatymai)
release_tests	Kiekviena turi id, name, release_name, hints ir expected (kind, quality, resolution, source, codec, flags)

Maršrutai ir atsakymai

Maršrutas	Sėkmė	Atmetimas
POST /api/v1/data-packs/validate	200 su valid ir santrauka	400 neteisingas, 413 per didelis
POST /api/v1/data-packs	201 su santrauka, būsena inactive	409 id jau yra, 400, 413
GET /api/v1/data-packs	200 su data_packs
GET /api/v1/data-packs/{id}	200 su paketo JSON	404
GET /api/v1/data-packs/{id}/preview	200 su approval_hash	400 bet kuriai užklausai, išskyrus pick_rule_id ir naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 su pack_id, pick_rule_ids, naming_id	409 pasenusi, 400, 404

Susiję puslapiai

• Metaduomenys
• Biblioteka