Lumaktaw sa nilalaman

Mga data pack

Eksperto

Kopyahin ang Mga patakaran sa pagpili, mga pattern ng pagpapangalan o mga pagsusuri ng pangalan ng release mo mula sa isang install papunta sa isa pa.

Ang data pack ay isang JSON file na data lang ang laman. Hindi ito makapagpapatakbo ng code, makakukuha ng address, makapagdaragdag ng pamagat, makapagbabago ng user, makagagalaw ng mga media file o makapagdadala ng mga sikreto.

  • Ikaw ang owner.
  • May API key ka na may scope na admin. Tinatanggihan ang mga key na may health_read, read o write.
  • Hawak mo ang JSON ng pack. Gamitin ang pack na ibinigay sa iyo, o magsulat ng isa mula sa hugis na nasa ilalim ng Para sa mga eksperto.

Lahat ng route ay nasa http://your-server:6262.

  1. Ipadala ang pack sa POST /api/v1/data-packs/validate. Sinusuri nito nang hindi nagse-save. Dapat makita mo ang "valid": true.
  2. Ipadala ang parehong JSON sa POST /api/v1/data-packs. Sine-save nito ang pack na hindi aktibo. Wala pang nagbabago.
  3. Buksan ang GET /api/v1/data-packs para ilista ang mga naka-save na pack. Ine-export ng GET /api/v1/data-packs/{id} ang isa.
  4. Buksan ang GET /api/v1/data-packs/{id}/preview na may isang pick_rule_id bawat patakaran at hanggang isang naming_id. Makakakuha ka ng approval_hash.
  5. Ipadala ang parehong pinili at ang hash sa POST /api/v1/data-packs/{id}/apply. Dapat makita mo ang id ng pack at ang mga id ng patakarang pinili mo.

Preview:

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

Body ng apply:

{
"pick_rule_ids": ["balanced-web"],
"naming_id": "readable",
"approval_hash": "the hash returned by preview"
}
  • Bawat piniling patakaran sa pagpili ay nagagawa bilang bago. Hindi ito itinatakda sa anumang pamagat.
  • Pinapalitan ng piniling naming set ang mga sumusunod na setting lang:
    • Mga pattern ng file at folder ng pelikula.
    • Mga pattern ng folder ng palabas, folder ng season, folder ng mga special, episode, daily at anime.
    • Mga pattern ng folder ng artist, folder ng album, folder ng disc, kanta at kanta sa maraming disc.
    • Pag-format ng colon at mga bawal na character.
    • Estilo ng maraming episode, estilo ng petsa ng pag-air at mga digit ng absolute number.
  • Ang pagpapalit ng pangalan sa import, pag-uugali ng folder, pagbasa ng tag at mga limitasyon ng scan ay hindi kailanman kasama sa pack.

Sintomas: Sinasabi ng Apply na luma na ang preview. Dahilan: Nagbago pagkatapos ng preview ang pack, ang pangalan ng patakaran sa pagpili na magbabanggaan, o ang naming setting na papalitan nito. Walang naipatupad. Solusyon: Mag-preview ulit at ipadala ang bagong hash.

Sintomas: Sinasabi ng import na nandiyan na ang pack. Dahilan: Hindi kailanman pinapalitan ang mga pack. Solusyon: Bigyan ang bagong pack ng ibang id.

Sintomas: Error sa permiso. Dahilan: Hindi admin key na ginawa ng owner ang key. Solusyon: Gumawa ng admin key bilang owner at gamitin iyon.

Mga limitasyon at pagtanggi
Limitasyon Halaga
format holyarrs-data-pack
version 1
Laki ng pack o ng export 256 KiB
Mga patakaran sa pagpili 32
Mga naming set 8
Mga pagsusuri ng pangalan ng release 256
Mga id 1 hanggang 64 na character: maliliit na letra, digit, tuldok, gitling, underscore. Magsimula at magtapos sa letra o digit
Body ng apply request 16 KiB

Tinatanggihan ang isang pack dahil sa dobleng field o hindi kilalang field, sobrang JSON pagkatapos ng dulo, hindi kilalang pangalan ng kalidad o katangian, maling salita sa pagpapangalan, bersyon na hindi 1, o mga halagang lampas sa mga limitasyong ito. Bawat pagsusuri ng pangalan ng release ay dumadaan sa parser ng HolyArrs at dapat tumugma sa bawat katotohanang inaasahan nito.

Hugis ng pack
Field Laman
format, version, id, name Kinakailangang header
pick_rules Bawat isa ay may id, name, kinds at rules (mga hakbang, katangian, limitasyon ng laki, protocol, wika, ayos)
naming Bawat isa ay may id, name at patterns (ang mga naming setting na nakalista sa itaas)
release_tests Bawat isa ay may id, name, release_name, hints at expected (kind, quality, resolution, source, codec, flags)
Mga route at tugon
Route Tagumpay Pagtanggi
POST /api/v1/data-packs/validate 200 na may valid at buod 400 hindi valid, 413 masyadong malaki
POST /api/v1/data-packs 201 na may buod, status inactive 409 nandiyan na ang id, 400, 413
GET /api/v1/data-packs 200 na may data_packs
GET /api/v1/data-packs/{id} 200 na may JSON ng pack 404
GET /api/v1/data-packs/{id}/preview 200 na may approval_hash 400 para sa anumang query bukod sa pick_rule_id at naming_id, 404
POST /api/v1/data-packs/{id}/apply 200 na may pack_id, pick_rule_ids, naming_id 409 luma na, 400, 404

Libre ang HolyArrs. Kung nakatipid ito ng oras mo, bigyan ito ng star sa GitHub, i-sponsor ito o ibili ako ng kape.