Datapakker

Kopier valgreglene, navnemønstrene eller release-navnsjekkene dine fra én installasjon til en annen.

En datapakke er en JSON-fil med bare data. Den kan ikke kjøre kode, hente en adresse, legge til en tittel, endre en bruker, røre mediafiler eller bære hemmeligheter.

Før du begynner

• Du er eier.
• Du har en API-nøkkel med tillatelsen admin. Nøkler med health_read, read eller write avvises.
• Du har pakke-JSON-en. Bruk pakken du fikk, eller skriv en etter formen under For viderekomne.

Flytt en pakke

Alle rutene ligger på http://your-server:6262.

1. Send pakken til POST /api/v1/data-packs/validate. Den sjekker uten å lagre. Du skal se "valid": true.
2. Send den samme JSON-en til POST /api/v1/data-packs. Den lagrer pakken som inaktiv. Ingenting endres ennå.
3. Åpne GET /api/v1/data-packs for å liste lagrede pakker. GET /api/v1/data-packs/{id} eksporterer én.
4. Åpne GET /api/v1/data-packs/{id}/preview med én pick_rule_id per regel og høyst én naming_id. Du får en approval_hash.
5. Send det samme valget og hashen til POST /api/v1/data-packs/{id}/apply. Du skal se pakke-id-en og regel-id-ene du valgte.

Forhåndsvisning:

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

Body for apply:

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

Advarsel

Et navnesett erstatter de gjeldende navnemønstrene dine. Eksisterende filer får ikke nytt navn.

Hva det endrer når du tar i bruk en pakke

• Hver valgregel du velger, opprettes som ny. Den er ikke tildelt noen tittel.
• Et valgt navnesett erstatter bare disse innstillingene:
  • Mønstre for filer og mapper til filmer.
  • Mønstre for seriemappe, sesongmappe, mappe for spesialepisoder, episode, daglig og anime.
  • Mønstre for artistmappe, albummappe, diskmappe, låt og låt på album med flere disker.
  • Formatering av kolon og ulovlige tegn.
  • Stil for flere episoder, stil for sendedato og siffer i absolutt nummer.
• Gi nytt navn ved import, oppførsel for mapper, lesing av tagger og skannegrenser er aldri med i en pakke.

Hvis det ikke fungerer

Symptom: apply sier at forhåndsvisningen er utdatert. Årsak: pakken, et navn på en valgregel som ville kollidert, eller en navneinnstilling som ville blitt erstattet, endret seg etter forhåndsvisningen. Ingenting ble tatt i bruk. Løsning: forhåndsvis på nytt og send den nye hashen.

Symptom: importen sier at pakken allerede finnes. Årsak: pakker erstattes aldri. Løsning: gi den nye pakken en annen id.

Symptom: tillatelsesfeil. Årsak: nøkkelen er ikke en admin-nøkkel laget av eieren. Løsning: opprett en admin-nøkkel som eier og bruk den.

For viderekomne

Grenser og avvisninger

Grense	Verdi
format	holyarrs-data-pack
version	1
Størrelse på en pakke eller en eksport	256 KiB
Valgregler	32
Navnesett	8
Release-navnsjekker	256
Id-er	1 til 64 tegn: små bokstaver, siffer, punktum, bindestreker, understreker. Begynn og slutt med en bokstav eller et siffer
Body i apply-forespørselen	16 KiB

En pakke avvises for doble eller ukjente felt, ekstra JSON etter slutten, ukjente kvalitets- eller egenskapsnavn, ugyldige navneord, en annen versjon enn 1, eller verdier over disse grensene. Hver release-navnsjekk kjøres gjennom HolyArrs-parseren og må matche alle fakta den forventer.

Form på pakken

Felt	Inneholder
format, version, id, name	Påkrevd header
pick_rules	Hver har id, name, kinds og rules (trinn, egenskaper, størrelsesgrenser, protokoll, språk, rekkefølge)
naming	Hver har id, name og patterns (navneinnstillingene listet over)
release_tests	Hver har id, name, release_name, hints og expected (type, kvalitet, oppløsning, kilde, codec, flagg)

Ruter og svar

Rute	Vellykket	Avvisning
POST /api/v1/data-packs/validate	200 med valid og en oppsummering	400 ugyldig, 413 for stor
POST /api/v1/data-packs	201 med en oppsummering, status inactive	409 id finnes, 400, 413
GET /api/v1/data-packs	200 med data_packs
GET /api/v1/data-packs/{id}	200 med pakke-JSON-en	404
GET /api/v1/data-packs/{id}/preview	200 med approval_hash	400 for alle spørringer andre enn pick_rule_id og naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 med pack_id, pick_rule_ids, naming_id	409 utdatert, 400, 404

Relatert

• Metadata
• Bibliotek