Paquets de dades

Copia les teves Regles d’elecció, patrons de noms o comprovacions de noms de llançament d’una instal·lació a una altra.

Un paquet de dades és un fitxer JSON només amb dades. No pot executar codi, ni obtenir una adreça, ni afegir un títol, ni canviar un usuari, ni tocar fitxers multimèdia, ni dur secrets.

Abans de començar

• Ets el propietari.
• Tens una clau d’API amb l’abast admin. Les claus amb health_read, read o write es rebutgen.
• Tens el JSON del paquet. Fes servir el paquet que t’han donat, o escriu-ne un a partir de la forma que hi ha sota Per a experts.

Moure un paquet

Totes les rutes són a http://your-server:6262.

1. Envia el paquet a POST /api/v1/data-packs/validate. Comprova sense desar. Hauries de veure "valid": true.
2. Envia el mateix JSON a POST /api/v1/data-packs. Desa el paquet com a inactiu. Encara no canvia res.
3. Obre GET /api/v1/data-packs per llistar els paquets desats. GET /api/v1/data-packs/{id} n’exporta un.
4. Obre GET /api/v1/data-packs/{id}/preview amb un pick_rule_id per regla i com a màxim un naming_id. Obtens un approval_hash.
5. Envia la mateixa tria i el hash a POST /api/v1/data-packs/{id}/apply. Hauries de veure l’id del paquet i els ids de les regles que has triat.

Previsualització:

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

Cos de l’aplicació:

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

Precaució

Un conjunt de noms substitueix els teus patrons de noms actuals. Els fitxers existents no es reanomenen.

Què canvia en aplicar

• Cada Regla d’elecció triada es crea de nou. No s’assigna a cap títol.
• Un conjunt de noms triat només substitueix aquests paràmetres:
  • Patrons de fitxer i carpeta de pel·lícules.
  • Patrons de carpeta de sèrie, carpeta de temporada, carpeta d’especials, episodi, diari i anime.
  • Patrons de carpeta d’artista, carpeta d’àlbum, carpeta de disc, cançó i cançó de diversos discs.
  • Format dels dos punts i dels caràcters il·legals.
  • Estil de diversos episodis, estil de data d’emissió i dígits del número absolut.
• Reanomenar en importar, el comportament de les carpetes, la lectura d’etiquetes i els límits d’exploració no són mai en un paquet.

Si no funciona

Símptoma: en aplicar diu que la previsualització està caducada. Causa: el paquet, el nom d’una Regla d’elecció que xocaria amb una altra o un paràmetre de noms que substituiria ha canviat després de la previsualització. No s’ha aplicat res. Solució: torna a previsualitzar i envia el hash nou.

Símptoma: la importació diu que el paquet ja existeix. Causa: els paquets mai no se substitueixen. Solució: dona al paquet nou un altre id.

Símptoma: error de permís. Causa: la clau no és una clau admin feta pel propietari. Solució: crea una clau admin com a propietari i fes-la servir.

Per a experts

Límits i rebuigs

Límit	Valor
format	holyarrs-data-pack
version	1
Mida d’un paquet o d’una exportació	256 KiB
Regles d’elecció	32
Conjunts de noms	8
Comprovacions de noms de llançament	256
Ids	d’1 a 64 caràcters: lletres minúscules, dígits, punts, guions i guions baixos. Comencen i acaben amb una lletra o un dígit
Cos de la petició d’aplicació	16 KiB

Un paquet es rebutja per camps duplicats o desconeguts, JSON addicional després del final, noms de qualitat o de tret desconeguts, paraules de noms errònies, una versió que no sigui 1 o valors que passin d’aquests límits. Cada comprovació de nom de llançament passa pel parser d’HolyArrs i ha de coincidir amb cada fet que espera.

Forma del paquet

Camp	Conté
format, version, id, name	Capçalera obligatòria
pick_rules	Cadascuna té id, name, kinds i rules (etapes, trets, límits de mida, protocol, idioma, ordre)
naming	Cadascun té id, name i patterns (els paràmetres de noms enumerats més amunt)
release_tests	Cadascuna té id, name, release_name, hints i expected (tipus, qualitat, resolució, font, codec, marques)

Rutes i respostes

Ruta	Èxit	Rebuig
POST /api/v1/data-packs/validate	200 amb valid i un resum	400 no vàlid, 413 massa gran
POST /api/v1/data-packs	201 amb un resum, estat inactive	409 l’id existeix, 400, 413
GET /api/v1/data-packs	200 amb data_packs
GET /api/v1/data-packs/{id}	200 amb el JSON del paquet	404
GET /api/v1/data-packs/{id}/preview	200 amb approval_hash	400 per qualsevol consulta que no sigui pick_rule_id i naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 amb pack_id, pick_rule_ids, naming_id	409 caducat, 400, 404

Relacionat

• Metadades
• Biblioteca