Paquetes de datos

Copia tus Reglas de elección, patrones de nombres o comprobaciones de nombres de lanzamiento de una instalación a otra.

Un paquete de datos es un archivo JSON que solo contiene datos. No puede ejecutar código, consultar una dirección, añadir un título, cambiar un usuario, tocar archivos multimedia ni llevar secretos.

Antes de empezar

• Eres el propietario.
• Tienes una clave de API con el alcance admin. Las claves con health_read, read o write se rechazan.
• Tienes el JSON del paquete. Usa el paquete que te dieron o escribe uno a partir de la estructura que está en Para expertos.

Mover un paquete

Todas las rutas están en http://your-server:6262.

1. Envía el paquete a POST /api/v1/data-packs/validate. Lo comprueba sin guardarlo. Deberías ver "valid": true.
2. Envía el mismo JSON a POST /api/v1/data-packs. Guarda el paquete como inactivo. Todavía no cambia nada.
3. Abre GET /api/v1/data-packs para ver los paquetes guardados. GET /api/v1/data-packs/{id} exporta uno.
4. Abre GET /api/v1/data-packs/{id}/preview con un pick_rule_id por regla y como mucho un naming_id. Recibes un approval_hash.
5. Envía la misma selección y el hash a POST /api/v1/data-packs/{id}/apply. Deberías ver el id del paquete y los ids de las reglas que elegiste.

Vista previa:

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

Cuerpo para aplicar:

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

Precaución

Un conjunto de nombres sustituye tus patrones de nombres actuales. Los archivos que ya existen no se renombran.

Qué cambia al aplicar

• Cada Regla de elección elegida se crea nueva. No se asigna a ningún título.
• Un conjunto de nombres elegido sustituye solo estos ajustes:
  • Patrones de archivo y carpeta de películas.
  • Patrones de carpeta de serie, carpeta de temporada, carpeta de especiales, episodio, diarios y anime.
  • Patrones de carpeta de artista, carpeta de álbum, carpeta de disco, pista y pista de varios discos.
  • Formato de los dos puntos y de los caracteres no permitidos.
  • Estilo de varios episodios, estilo de fecha de emisión y dígitos del número absoluto.
• Renombrar al importar, el comportamiento de las carpetas, la lectura de etiquetas y los límites de escaneo nunca van en un paquete.

Si no funciona

Síntoma: Al aplicar dice que la vista previa está desactualizada. Causa: El paquete, un nombre de Regla de elección que chocaría o un ajuste de nombres que se sustituiría cambió después de la vista previa. No se aplicó nada. Solución: Pide la vista previa otra vez y envía el hash nuevo.

Síntoma: Al importar dice que el paquete ya existe. Causa: Los paquetes nunca se sustituyen. Solución: Dale otro id al paquete nuevo.

Síntoma: Error de permisos. Causa: La clave no es una clave admin creada por el propietario. Solución: Crea una clave admin como propietario y úsala.

Para expertos

Límites y rechazos

Límite	Valor
format	holyarrs-data-pack
version	1
Tamaño de un paquete o de una exportación	256 KiB
Reglas de elección	32
Conjuntos de nombres	8
Comprobaciones de nombres de lanzamiento	256
Ids	De 1 a 64 caracteres: letras minúsculas, dígitos, puntos, guiones, guiones bajos. Empiezan y terminan con una letra o un dígito
Cuerpo de la petición para aplicar	16 KiB

Un paquete se rechaza por campos duplicados o desconocidos, JSON de más después del final, nombres de calidad o de rasgo desconocidos, palabras de nombres incorrectas, una versión distinta de 1 o valores que pasan estos límites. Cada comprobación de nombre de lanzamiento pasa por el analizador de HolyArrs y debe coincidir con todos los datos que espera.

Estructura del paquete

Campo	Contiene
format, version, id, name	Cabecera obligatoria
pick_rules	Cada una tiene id, name, kinds y rules (escalones, rasgos, límites de tamaño, protocolo, idioma, orden)
naming	Cada uno tiene id, name y patterns (los ajustes de nombres de la lista de arriba)
release_tests	Cada una tiene id, name, release_name, hints y expected (tipo, calidad, resolución, origen, codec, marcas)

Rutas y respuestas

Ruta	Éxito	Rechazo
POST /api/v1/data-packs/validate	200 con valid y un resumen	400 no válido, 413 demasiado grande
POST /api/v1/data-packs	201 con un resumen, estado inactive	409 el id ya existe, 400, 413
GET /api/v1/data-packs	200 con data_packs
GET /api/v1/data-packs/{id}	200 con el JSON del paquete	404
GET /api/v1/data-packs/{id}/preview	200 con approval_hash	400 por cualquier parámetro que no sea pick_rule_id o naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 con pack_id, pick_rule_ids, naming_id	409 desactualizada, 400, 404

Relacionado

• Metadatos
• Biblioteca