Paczki danych

Skopiuj swoje reguły wyboru, wzorce nazewnictwa albo testy nazw release’ów z jednej instalacji do drugiej.

Paczka danych to plik JSON zawierający tylko dane. Nie może uruchamiać kodu, pobierać adresu, dodawać tytułu, zmieniać użytkownika, dotykać plików multimedialnych ani przenosić sekretów.

Zanim zaczniesz

• Jesteś właścicielem.
• Masz klucz API z zakresem admin. Klucze z health_read, read lub write są odrzucane.
• Masz JSON paczki. Użyj otrzymanej paczki albo napisz własną według schematu w sekcji Dla zaawansowanych.

Przenieś paczkę

Wszystkie trasy są pod adresem http://your-server:6262.

1. Wyślij paczkę na POST /api/v1/data-packs/validate. Sprawdza ją bez zapisywania. Zobaczysz "valid": true.
2. Wyślij ten sam JSON na POST /api/v1/data-packs. Zapisuje paczkę jako nieaktywną. Nic się jeszcze nie zmienia.
3. Otwórz GET /api/v1/data-packs, żeby wyświetlić zapisane paczki. GET /api/v1/data-packs/{id} eksportuje jedną.
4. Otwórz GET /api/v1/data-packs/{id}/preview z jednym pick_rule_id na regułę i co najwyżej jednym naming_id. Dostaniesz approval_hash.
5. Wyślij ten sam wybór i hash na POST /api/v1/data-packs/{id}/apply. Zobaczysz id paczki i id wybranych reguł.

Podgląd:

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

Treść zastosowania:

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

Uwaga

Zestaw nazewnictwa zastępuje twoje obecne wzorce nazewnictwa. Istniejące pliki nie są zmieniane.

Co zmienia zastosowanie

• Każda wybrana reguła wyboru jest tworzona od nowa. Nie jest przypisana do żadnego tytułu.
• Wybrany zestaw nazewnictwa zastępuje tylko te ustawienia:
  • Wzorce plików i folderów filmów.
  • Wzorce folderu serialu, folderu sezonu, folderu odcinków specjalnych, odcinka, odcinka dziennego i anime.
  • Wzorce folderu wykonawcy, folderu albumu, folderu płyty, utworu i utworu na wielu płytach.
  • Formatowanie dwukropka i niedozwolonych znaków.
  • Styl wielu odcinków, styl daty emisji i liczba cyfr numeru ciągłego.
• Zmiana nazw przy imporcie, zachowanie folderów, odczyt tagów i limity skanowania nigdy nie wchodzą do paczki.

Jeśli to nie działa

Objaw: zastosowanie mówi, że podgląd jest nieaktualny. Przyczyna: po podglądzie zmieniła się paczka, nazwa reguły wyboru, która by się zdublowała, albo ustawienie nazewnictwa, które miało być zastąpione. Nic nie zostało zastosowane. Rozwiązanie: zrób podgląd jeszcze raz i wyślij nowy hash.

Objaw: import mówi, że paczka już istnieje. Przyczyna: paczki nigdy nie są zastępowane. Rozwiązanie: nadaj nowej paczce inne id.

Objaw: błąd uprawnień. Przyczyna: klucz nie jest kluczem admin utworzonym przez właściciela. Rozwiązanie: utwórz klucz admin jako właściciel i użyj go.

Dla zaawansowanych

Limity i odrzucenia

Limit	Wartość
format	holyarrs-data-pack
version	1
Rozmiar paczki lub eksportu	256 KiB
Reguły wyboru	32
Zestawy nazewnictwa	8
Testy nazw release’ów	256
Id	1 do 64 znaków: małe litery, cyfry, kropki, myślniki, podkreślenia. Zaczynają się i kończą literą lub cyfrą
Treść żądania zastosowania	16 KiB

Paczka jest odrzucana za zdublowane lub nieznane pola, dodatkowy JSON po końcu, nieznane nazwy jakości lub cech, błędne słowa nazewnictwa, wersję inną niż 1 albo wartości ponad te limity. Każdy test nazwy release’u przechodzi przez parser HolyArrs i musi pasować do każdego faktu, którego oczekuje.

Schemat paczki

Pole	Zawiera
format, version, id, name	Wymagany nagłówek
pick_rules	Każda ma id, name, kinds i rules (stopnie, cechy, limity rozmiaru, protokół, język, kolejność)
naming	Każdy ma id, name i patterns (ustawienia nazewnictwa wymienione wyżej)
release_tests	Każdy ma id, name, release_name, hints i expected (rodzaj, jakość, rozdzielczość, źródło, kodek, flagi)

Trasy i odpowiedzi

Trasa	Powodzenie	Odrzucenie
POST /api/v1/data-packs/validate	200 z valid i podsumowaniem	400 nieprawidłowa, 413 za duża
POST /api/v1/data-packs	201 z podsumowaniem, status inactive	409 id istnieje, 400, 413
GET /api/v1/data-packs	200 z data_packs
GET /api/v1/data-packs/{id}	200 z JSON-em paczki	404
GET /api/v1/data-packs/{id}/preview	200 z approval_hash	400 dla każdego zapytania innego niż pick_rule_id i naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 z pack_id, pick_rule_ids, naming_id	409 nieaktualne, 400, 404

Powiązane strony

• Metadane
• Biblioteka