Пакети с данни

Копирай Правилата си за избор, шаблоните за имена или проверките на имена на издания от една инсталация в друга.

Пакетът с данни е JSON файл само с данни. Той не може да изпълнява код, да взема адрес, да добавя заглавие, да променя потребител, да докосва медийни файлове или да носи тайни.

Преди да започнеш

• Ти си собственикът.
• Имаш API ключ с обхват admin. Ключове с health_read, read или write се отхвърлят.
• Имаш JSON на пакета. Ползвай пакета, който са ти дали, или напиши свой по формата под За експерти.

Премести пакет

Всички маршрути са на http://your-server:6262.

1. Изпрати пакета към POST /api/v1/data-packs/validate. Той проверява, без да запазва. Трябва да видиш "valid": true.
2. Изпрати същия JSON към POST /api/v1/data-packs. Той запазва пакета като неактивен. Още нищо не се променя.
3. Отвори GET /api/v1/data-packs, за да изброиш запазените пакети. GET /api/v1/data-packs/{id} изнася един.
4. Отвори GET /api/v1/data-packs/{id}/preview с по един pick_rule_id за правило и най-много един naming_id. Получаваш approval_hash.
5. Изпрати същия избор и хеша към POST /api/v1/data-packs/{id}/apply. Трябва да видиш id на пакета и id-тата на правилата, които си избрал.

Преглед:

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

Тяло на прилагането:

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

Caution

Наборът за имена замества текущите ти шаблони за имена. Съществуващите файлове не се преименуват.

Какво променя прилагането

• Всяко избрано Правило за избор се създава ново. То не е зададено на никое заглавие.
• Избраният набор за имена замества само тези настройки:
  • Шаблони за файла и папката на филма.
  • Шаблони за папка на сериал, папка на сезон, папка на специални епизоди, епизод, дневен и аниме.
  • Шаблони за папка на изпълнител, папка на албум, папка на диск, песен и песен от многодисков албум.
  • Форматиране на двоеточие и забранени знаци.
  • Стил на няколко епизода, стил на датата на излъчване и цифри на абсолютния номер.
• Преименуването при импортиране, поведението на папките, четенето на тагове и ограниченията на сканирането никога не са в пакет.

Ако не работи

Проблем: прилагането казва, че прегледът е остарял. Причина: пакетът, име на Правило за избор, което би се сблъскало, или настройка за имена, която би се заменила, се е променила след прегледа. Нищо не е приложено. Решение: прегледай отново и изпрати новия хеш.

Проблем: импортирането казва, че пакетът вече съществува. Причина: пакетите никога не се заменят. Решение: дай на новия пакет друго id.

Проблем: грешка за права. Причина: ключът не е admin ключ, създаден от собственика. Решение: създай admin ключ като собственик и го използвай.

За експерти

Ограничения и откази

Ограничение	Стойност
format	holyarrs-data-pack
version	1
Размер на пакет или експорт	256 KiB
Правила за избор	32
Набори за имена	8
Проверки на имена на издания	256
Id-та	от 1 до 64 знака: малки букви, цифри, точки, тирета, долни черти. Започват и свършват с буква или цифра
Тяло на заявката за прилагане	16 KiB

Пакетът се отхвърля при дублирани или непознати полета, допълнителен JSON след края, непознати имена на качество или признак, лоши думи за имена, версия, различна от 1, или стойности над тези ограничения. Всяка проверка на име на издание минава през парсера на HolyArrs и трябва да съвпадне с всеки факт, който очаква.

Формат на пакета

Поле	Съдържа
format, version, id, name	Задължително заглавие
pick_rules	Всяко има id, name, kinds и rules (стъпки, признаци, ограничения на размера, протокол, език, ред)
naming	Всяко има id, name и patterns (изброените по-горе настройки за имена)
release_tests	Всяка има id, name, release_name, hints и expected (вид, качество, резолюция, източник, codec, флагове)

Маршрути и отговори

Маршрут	Успех	Отказ
POST /api/v1/data-packs/validate	200 с valid и обобщение	400 невалиден, 413 твърде голям
POST /api/v1/data-packs	201 с обобщение, състояние inactive	409 id съществува, 400, 413
GET /api/v1/data-packs	200 с data_packs
GET /api/v1/data-packs/{id}	200 с JSON на пакета	404
GET /api/v1/data-packs/{id}/preview	200 с approval_hash	400 за всяка заявка освен pick_rule_id и naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 с pack_id, pick_rule_ids, naming_id	409 остарял, 400, 404

Свързано

• Метаданни
• Библиотека