Datapaket

Kopiera dina urvalsregler, namnmönster eller releasenamnskontroller från en installation till en annan.

Ett datapaket är en JSON-fil som bara innehåller data. Det kan inte köra kod, hämta en adress, lägga till en titel, ändra en användare, röra mediafiler eller bära hemligheter.

Innan du börjar

• Du är ägaren.
• Du har en API-nyckel med behörighetsnivån admin. Nycklar med health_read, read eller write avvisas.
• Du har paketets JSON. Använd paketet du fått, eller skriv ett utifrån formen under För experter.

Flytta ett paket

Alla routes ligger på http://your-server:6262.

1. Skicka paketet till POST /api/v1/data-packs/validate. Den kontrollerar utan att spara. Du ska se "valid": true.
2. Skicka samma JSON till POST /api/v1/data-packs. Den sparar paketet som inaktivt. Inget ändras ännu.
3. Öppna GET /api/v1/data-packs för att lista sparade paket. GET /api/v1/data-packs/{id} exporterar ett.
4. Öppna GET /api/v1/data-packs/{id}/preview med ett pick_rule_id per regel och högst ett naming_id. Du får en approval_hash.
5. Skicka samma val och hashen till POST /api/v1/data-packs/{id}/apply. Du ska se paketets id och regel-id:na du valde.

Förhandsgranskning:

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

Body för tillämpning:

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

Caution

En namnuppsättning ersätter dina nuvarande namnmönster. Befintliga filer döps inte om.

Vad tillämpningen ändrar

• Varje vald urvalsregel skapas ny. Den tilldelas ingen titel.
• En vald namnuppsättning ersätter bara de här inställningarna:
  • Mönster för filmfiler och filmmappar.
  • Mönster för seriemapp, säsongsmapp, specialavsnittsmapp, avsnitt, dagliga avsnitt och anime.
  • Mönster för artistmapp, albummapp, skivmapp, spår och spår på flera skivor.
  • Formatering av kolon och otillåtna tecken.
  • Stil för flera avsnitt, stil för sändningsdatum och antal siffror i absolut numrering.
• Namnbyte vid import, mappbeteende, taggläsning och skanningsgränser ingår aldrig i ett paket.

Om det inte fungerar

Symptom: tillämpningen säger att förhandsgranskningen är föråldrad. Orsak: paketet, ett urvalsregelnamn som skulle krocka eller en namninställning som skulle ersättas ändrades efter förhandsgranskningen. Ingenting tillämpades. Lösning: förhandsgranska igen och skicka den nya hashen.

Symptom: importen säger att paketet redan finns. Orsak: paket ersätts aldrig. Lösning: ge det nya paketet ett annat id.

Symptom: behörighetsfel. Orsak: nyckeln är inte en admin-nyckel skapad av ägaren. Lösning: skapa en admin-nyckel som ägare och använd den.

För experter

Gränser och avslag

Gräns	Värde
format	holyarrs-data-pack
version	1
Storlek på ett paket eller en export	256 KiB
Urvalsregler	32
Namnuppsättningar	8
Releasenamnskontroller	256
Id:n	1 till 64 tecken: gemener, siffror, punkter, bindestreck, understreck. Börja och sluta med en bokstav eller siffra
Body i tillämpningsanropet	16 KiB

Ett paket avvisas vid dubbla eller okända fält, extra JSON efter slutet, okända kvalitets- eller egenskapsnamn, felaktiga namnord, en annan version än 1 eller värden över de här gränserna. Varje releasenamnskontroll körs genom HolyArrs tolkare och måste matcha varje faktum den förväntar sig.

Paketets form

Fält	Innehåller
format, version, id, name	Obligatoriskt huvud
pick_rules	Var och en har id, name, kinds och rules (steg, egenskaper, storleksgränser, protokoll, språk, ordning)
naming	Var och en har id, name och patterns (namninställningarna som listas ovan)
release_tests	Var och en har id, name, release_name, hints och expected (kind, quality, resolution, source, codec, flags)

Routes och svar

Route	Lyckat	Avslag
POST /api/v1/data-packs/validate	200 med valid och en sammanfattning	400 ogiltigt, 413 för stort
POST /api/v1/data-packs	201 med en sammanfattning, status inactive	409 id finns, 400, 413
GET /api/v1/data-packs	200 med data_packs
GET /api/v1/data-packs/{id}	200 med paketets JSON	404
GET /api/v1/data-packs/{id}/preview	200 med approval_hash	400 för alla frågor utom pick_rule_id och naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 med pack_id, pick_rule_ids, naming_id	409 föråldrad, 400, 404

Relaterat

• Metadata
• Bibliotek