Pāriet uz saturu

Datu pakotnes

Pieredzējušiem

Kopē savus izvēles noteikumus, nosaukumu veidnes vai izlaidumu nosaukumu pārbaudes no vienas instalācijas uz citu.

Datu pakotne ir JSON fails, kurā ir tikai dati. Tā nevar izpildīt kodu, izgūt adresi, pievienot nosaukumu, mainīt lietotāju, aizskart multivides failus vai nest noslēpumus.

  • Tu esi īpašnieks.
  • Tev ir API atslēga ar admin darbības jomu. Atslēgas ar health_read, read vai write tiek atteiktas.
  • Tev ir pakotnes JSON. Izmanto pakotni, ko tev iedeva, vai uzraksti savu pēc formas sadaļā Pieredzējušiem.

Visi maršruti ir uz http://your-server:6262.

  1. Nosūti pakotni uz POST /api/v1/data-packs/validate. Tas pārbauda, nesaglabājot. Tev vajadzētu redzēt "valid": true.
  2. Nosūti to pašu JSON uz POST /api/v1/data-packs. Tas saglabā pakotni kā neaktīvu. Pagaidām nekas nemainās.
  3. Atver GET /api/v1/data-packs, lai uzskaitītu saglabātās pakotnes. GET /api/v1/data-packs/{id} eksportē vienu.
  4. Atver GET /api/v1/data-packs/{id}/preview ar vienu pick_rule_id katram noteikumam un ne vairāk kā vienu naming_id. Tu saņem approval_hash.
  5. Nosūti to pašu izvēli un jaucējkodu uz POST /api/v1/data-packs/{id}/apply. Tev vajadzētu redzēt pakotnes id un noteikumu id, ko izvēlējies.

Pārskats:

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

Apply pieprasījuma saturs:

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

Ko piemērošana maina

Saite uz Ko piemērošana maina
  • Katrs izvēlētais izvēles noteikums tiek izveidots no jauna. Tas netiek piešķirts nevienam nosaukumam.
  • Izvēlētā nosaukumu kopa aizstāj tikai šos iestatījumus:
    • Filmu failu un mapju veidnes.
    • Seriāla mapes, sezonas mapes, speciālo epizožu mapes, epizožu, ikdienas un anime veidnes.
    • Izpildītāja mapes, albuma mapes, diska mapes, ieraksta un vairāku disku ierakstu veidnes.
    • Kola un neatļauto rakstzīmju formatēšana.
    • Vairāku epizožu stils, pārraides datuma stils un absolūtā numura cipari.
  • Pārsaukšana importa laikā, mapju uzvedība, birku lasīšana un skenēšanas ierobežojumi nekad nav pakotnē.

Simptoms: Apply saka, ka pārskats ir novecojis. Cēlonis: pēc pārskata mainījās pakotne, izvēles noteikuma nosaukums, kas sadurtos, vai nosaukumu iestatījums, ko tas aizstātu. Nekas netika piemērots. Risinājums: pārskati vēlreiz un nosūti jauno jaucējkodu.

Simptoms: Imports saka, ka pakotne jau pastāv. Cēlonis: pakotnes nekad netiek aizstātas. Risinājums: dod jaunajai pakotnei citu id.

Simptoms: atļaujas kļūda. Cēlonis: atslēga nav īpašnieka izveidota admin atslēga. Risinājums: izveido admin atslēgu kā īpašnieks un izmanto to.

Ierobežojumi un atteikumi
Ierobežojums Vērtība
format holyarrs-data-pack
version 1
Pakotnes vai eksporta izmērs 256 KiB
Izvēles noteikumi 32
Nosaukumu kopas 8
Izlaidumu nosaukumu pārbaudes 256
Id 1 līdz 64 rakstzīmes: mazie burti, cipari, punkti, domuzīmes, pasvītras. Sākas un beidzas ar burtu vai ciparu
Apply pieprasījuma saturs 16 KiB

Pakotne tiek atteikta par dublētiem vai nezināmiem laukiem, papildu JSON pēc beigām, nezināmiem kvalitātes vai pazīmju nosaukumiem, sliktiem nosaukumu vārdiem, versiju, kas nav 1, vai vērtībām pāri šiem ierobežojumiem. Katra izlaiduma nosaukuma pārbaude tiek palaista caur HolyArrs parsētāju un tai jāatbilst visiem faktiem, ko tā gaida.

Pakotnes forma
Lauks Satur
format, version, id, name Obligātā galvene
pick_rules Katram ir id, name, kinds un rules (pakāpes, pazīmes, izmēra ierobežojumi, protokols, valoda, secība)
naming Katram ir id, name un patterns (iepriekš uzskaitītie nosaukumu iestatījumi)
release_tests Katram ir id, name, release_name, hints un expected (veids, kvalitāte, izšķirtspēja, avots, codec, karodziņi)
Maršruti un atbildes
Maršruts Veiksme Atteikums
POST /api/v1/data-packs/validate 200 ar valid un kopsavilkumu 400 nederīgs, 413 pārāk liels
POST /api/v1/data-packs 201 ar kopsavilkumu, statuss inactive 409 id pastāv, 400, 413
GET /api/v1/data-packs 200 ar data_packs
GET /api/v1/data-packs/{id} 200 ar pakotnes JSON 404
GET /api/v1/data-packs/{id}/preview 200 ar approval_hash 400 jebkuram vaicājumam, kas nav pick_rule_id un naming_id, 404
POST /api/v1/data-packs/{id}/apply 200 ar pack_id, pick_rule_ids, naming_id 409 novecojis, 400, 404

HolyArrs ir bezmaksas. Ja tas ietaupīja tavu laiku, atzīmē to ar zvaigznīti GitHub, atbalsti to vai uzcienā mani ar kafiju.