Datapakker

Kopiér dine udvalgsregler, navngivningsmønstre eller tjek af release-navne fra én installation til en anden.

En datapakke er en JSON-fil med kun data. Den kan ikke køre kode, hente en adresse, tilføje en titel, ændre en bruger, røre mediefiler eller indeholde hemmeligheder.

Før du begynder

• Du er ejer.
• Du har en API-nøgle med scopet admin. Nøgler med health_read, read eller write bliver afvist.
• Du har pakkens JSON. Brug den pakke, du har fået, eller skriv en ud fra formen under For erfarne.

Flyt en pakke

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

1. Send pakken til POST /api/v1/data-packs/validate. Den tjekker uden at gemme. Du bør kunne se "valid": true.
2. Send den samme JSON til POST /api/v1/data-packs. Den gemmer pakken som inaktiv. Der ændres intet endnu.
3. Åbn GET /api/v1/data-packs for at se gemte pakker. GET /api/v1/data-packs/{id} eksporterer én.
4. Åbn GET /api/v1/data-packs/{id}/preview med ét pick_rule_id pr. regel og højst ét naming_id. Du får en approval_hash.
5. Send det samme valg og hashen til POST /api/v1/data-packs/{id}/apply. Du bør kunne se pakkens id og de regel-id’er, du valgte.

Preview:

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

Apply-body:

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

Bemærk

Et navngivningssæt erstatter dine nuværende navngivningsmønstre. Eksisterende filer bliver ikke omdøbt.

Hvad anvendelsen ændrer

• Hver valgt udvalgsregel oprettes ny. Den er ikke tildelt nogen titel.
• Et valgt navngivningssæt erstatter kun disse indstillinger:
  • Mønstre for filmfiler og -mapper.
  • Mønstre for seriemappe, sæsonmappe, specialsmappe, afsnit, daglige serier og anime.
  • Mønstre for kunstnermappe, albummappe, diskmappe, nummer og nummer på flerdiskalbum.
  • Formatering af kolon og ulovlige tegn.
  • Stil for flere afsnit i én fil, stil for sendedato og antal cifre i absolut nummer.
• Omdøbning ved import, mappeadfærd, læsning af tags og scanningsgrænser er aldrig en del af en pakke.

Hvis det ikke virker

Symptom: Apply siger, at preview er forældet. Årsag: pakken, et navn på en udvalgsregel, der ville kollidere, eller en navngivningsindstilling, der ville blive erstattet, er ændret efter preview. Intet blev anvendt. Løsning: kør preview igen og send den nye hash.

Symptom: import siger, at pakken allerede findes. Årsag: pakker bliver aldrig erstattet. Løsning: giv den nye pakke et andet id.

Symptom: rettighedsfejl. Årsag: nøglen er ikke en admin-nøgle oprettet af ejeren. Løsning: opret en admin-nøgle som ejer og brug den.

For erfarne

Grænser og afvisninger

Grænse	Værdi
format	holyarrs-data-pack
version	1
Størrelse på en pakke eller en eksport	256 KiB
Udvalgsregler	32
Navngivningssæt	8
Tjek af release-navne	256
Id’er	1 til 64 tegn: små bogstaver, cifre, punktummer, bindestreger, understreger. Begynd og slut med et bogstav eller ciffer
Body i en apply-forespørgsel	16 KiB

En pakke afvises ved dobbelte eller ukendte felter, ekstra JSON efter slutningen, ukendte kvalitets- eller egenskabsnavne, forkerte navngivningsord, en anden version end 1 eller værdier over disse grænser. Hvert tjek af et release-navn kører gennem HolyArrs’ parser og skal matche alle de fakta, det forventer.

Pakkens form

Felt	Indeholder
format, version, id, name	Påkrævet header
pick_rules	Hver har id, name, kinds og rules (trin, egenskaber, størrelsesgrænser, protokol, sprog, rækkefølge)
naming	Hver har id, name og patterns (de navngivningsindstillinger, der er nævnt ovenfor)
release_tests	Hver har id, name, release_name, hints og expected (type, kvalitet, opløsning, kilde, codec, flag)

Ruter og svar

Rute	Succes	Afvisning
POST /api/v1/data-packs/validate	200 med valid og en oversigt	400 ugyldig, 413 for stor
POST /api/v1/data-packs	201 med en oversigt, status inactive	409 id findes, 400, 413
GET /api/v1/data-packs	200 med data_packs
GET /api/v1/data-packs/{id}	200 med pakkens JSON	404
GET /api/v1/data-packs/{id}/preview	200 med approval_hash	400 ved enhver forespørgsel ud over pick_rule_id og naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 med pack_id, pick_rule_ids, naming_id	409 forældet, 400, 404

Se også

• Metadata
• Bibliotek