Andmepaketid

Kopeeri oma valikureeglid, nimetamismustrid või väljalaskenimede kontrollid ühest paigaldusest teise.

Andmepakett on JSON-fail, milles on ainult andmed. See ei saa käivitada koodi, tuua aadressi, lisada pealkirja, muuta kasutajat, puutuda meediafaile ega kanda saladusi.

Enne alustamist

• Sa oled omanik.
• Sul on API-võti skoobiga admin. Võtmed skoobiga health_read, read või write lükatakse tagasi.
• Sul on paketi JSON. Kasuta paketti, mille said, või kirjuta see jaotise Asjatundjale kuju järgi.

Liiguta pakett

Kõik marsruudid asuvad aadressil http://your-server:6262.

1. Saada pakett aadressile POST /api/v1/data-packs/validate. See kontrollib ilma salvestamata. Näed "valid": true.
2. Saada sama JSON aadressile POST /api/v1/data-packs. See salvestab paketi mitteaktiivsena. Midagi ei muutu veel.
3. Ava GET /api/v1/data-packs, et loetleda salvestatud paketid. GET /api/v1/data-packs/{id} ekspordib ühe.
4. Ava GET /api/v1/data-packs/{id}/preview ühe pick_rule_id-ga iga reegli kohta ja kuni ühe naming_id-ga. Saad approval_hash-i.
5. Saada sama valik ja räsi aadressile POST /api/v1/data-packs/{id}/apply. Näed paketi id-d ja valitud reeglite id-sid.

Eelvaade:

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

Rakendamise päringu sisu:

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

Caution

Nimetamiskomplekt asendab sinu praegused nimetamismustrid. Olemasolevaid faile ei nimetata ümber.

Mida rakendamine muudab

• Iga valitud valikureegel luuakse uuena. Seda ei määrata ühelegi pealkirjale.
• Valitud nimetamiskomplekt asendab ainult need sätted:
  • Filmi faili ja kausta mustrid.
  • Sarja kausta, hooaja kausta, eriepisoodide kausta, episoodi, päeva ja anime mustrid.
  • Esitaja kausta, albumi kausta, ketta kausta, loo ja mitme ketta loo mustrid.
  • Koolonite ja keelatud märkide vormindamine.
  • Mitme episoodi stiil, eetrikuupäeva stiil ja absoluutnumbri kohtade arv.
• Ümbernimetamine importimisel, kaustade käitumine, siltide lugemine ja skannimise piirid ei ole kunagi paketis.

Kui see ei tööta

Sümptom: rakendamine ütleb, et eelvaade on aegunud. Põhjus: pakett, valikureegli nimi, mis tekitaks konflikti, või nimetamissäte, mis asendataks, muutus pärast eelvaadet. Midagi ei rakendatud. Lahendus: tee eelvaade uuesti ja saada uus räsi.

Sümptom: import ütleb, et pakett on juba olemas. Põhjus: pakette ei asendata kunagi. Lahendus: anna uuele paketile teine id.

Sümptom: õiguse viga. Põhjus: võti ei ole omaniku tehtud admin-võti. Lahendus: loo omanikuna admin-võti ja kasuta seda.

Asjatundjale

Piirid ja keeldumised

Piir	Väärtus
format	holyarrs-data-pack
version	1
Paketi või ekspordi suurus	256 KiB
Valikureeglid	32
Nimetamiskomplektid	8
Väljalaskenimede kontrollid	256
Id-d	1 kuni 64 märki: väiksed tähed, numbrid, punktid, sidekriipsud, alakriipsud. Algavad ja lõpevad tähe või numbriga
Rakendamise päringu sisu	16 KiB

Pakett lükatakse tagasi dubleeritud või tundmatute väljade, JSON-i lõpu järel oleva lisa, tundmatute kvaliteedi- või tunnusenimede, vigaste nimetamissõnade, muu versiooni kui 1 või nende piiride ületavate väärtuste pärast. Iga väljalaskenime kontroll läbib HolyArrsi parseri ja peab sobima iga andmega, mida see ootab.

Paketi kuju

Väli	Sisaldab
format, version, id, name	Nõutav päis
pick_rules	Igaühel on id, name, kinds ja rules (sammud, tunnused, suuruse piirid, protokoll, keel, järjekord)
naming	Igaühel on id, name ja patterns (ülal loetletud nimetamissätted)
release_tests	Igaühel on id, name, release_name, hints ja expected (liik, kvaliteet, eraldusvõime, allikas, koodek, lipud)

Marsruudid ja vastused

Marsruut	Õnnestumine	Keeldumine
POST /api/v1/data-packs/validate	200 koos valid ja kokkuvõttega	400 vigane, 413 liiga suur
POST /api/v1/data-packs	201 koos kokkuvõttega, olek inactive	409 id on olemas, 400, 413
GET /api/v1/data-packs	200 koos data_packs
GET /api/v1/data-packs/{id}	200 koos paketi JSON-iga	404
GET /api/v1/data-packs/{id}/preview	200 koos approval_hash-iga	400 iga muu päringu kui pick_rule_id ja naming_id korral, 404
POST /api/v1/data-packs/{id}/apply	200 koos pack_id, pick_rule_ids, naming_id	409 aegunud, 400, 404

Seotud lehed

• Metaandmed
• Meediakogu