Пакети података

Копирај своја правила избора, шаблоне именовања или провере назива релиза са једне инсталације на другу.

Пакет података је 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 (врста, квалитет, резолуција, извор, кодек, заставице)

Руте и одговори

Рута	Успех	Одбијање
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

Повезане странице

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