Data-paketit

Kopioi valintasäännöt, nimeämismallit tai julkaisunimen tarkistukset asennuksesta toiseen.

Data-paketti on JSON-tiedosto, jossa on vain dataa. Se ei voi suorittaa koodia, hakea osoitetta, lisätä nimikettä, muuttaa käyttäjää, koskea mediatiedostoihin tai kuljettaa salaisuuksia.

Ennen kuin aloitat

• Olet omistaja.
• Sinulla on API-avain, jolla on admin-oikeusalue. Avaimet, joilla on health_read, read tai write, hylätään.
• Sinulla on paketin JSON. Käytä saamaasi pakettia tai kirjoita oma kohdan Asiantuntijoille rakenteen mukaan.

Siirrä paketti

Kaikki reitit ovat osoitteessa http://your-server:6262.

1. Lähetä paketti reitille POST /api/v1/data-packs/validate. Se tarkistaa paketin tallentamatta sitä. Näet "valid": true.
2. Lähetä sama JSON reitille POST /api/v1/data-packs. Se tallentaa paketin ei-aktiivisena. Mikään ei vielä muutu.
3. Avaa GET /api/v1/data-packs nähdäksesi tallennetut paketit. GET /api/v1/data-packs/{id} vie yhden.
4. Avaa GET /api/v1/data-packs/{id}/preview yhdellä pick_rule_id:llä per sääntö ja enintään yhdellä naming_id:llä. Saat approval_hash-arvon.
5. Lähetä sama valinta ja tiiviste reitille POST /api/v1/data-packs/{id}/apply. Näet paketin id:n ja valitsemiesi sääntöjen id:t.

Esikatselu:

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

Käyttöönoton runko:

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

Varoitus

Nimeämisjoukko korvaa nykyiset nimeämismallisi. Olemassa olevia tiedostoja ei nimetä uudelleen.

Mitä käyttöönotto muuttaa

• Jokainen valittu valintasääntö luodaan uutena. Sitä ei liitetä mihinkään nimikkeeseen.
• Valittu nimeämisjoukko korvaa vain nämä asetukset:
  • Elokuvan tiedosto- ja kansiomallit.
  • Sarjan kansion, tuotantokauden kansion, erikoisjaksojen kansion, jakson, päivittäisen sarjan ja animen mallit.
  • Artistin kansion, albumin kansion, levyn kansion, kappaleen ja usean levyn kappaleen mallit.
  • Kaksoispisteen ja kiellettyjen merkkien muotoilu.
  • Usean jakson tyyli, lähetyspäivän tyyli ja absoluuttisen numeron numeroiden määrä.
• Nimeäminen tuonnissa, kansioiden toiminta, tagien luku ja skannausrajat eivät koskaan kuulu pakettiin.

Jos se ei toimi

Oire: käyttöönotto sanoo, että esikatselu on vanhentunut. Syy: paketti, nimeltään ristiriitaan joutuva valintasääntö tai korvattava nimeämisasetus muuttui esikatselun jälkeen. Mitään ei otettu käyttöön. Ratkaisu: esikatsele uudelleen ja lähetä uusi tiiviste.

Oire: tuonti sanoo, että paketti on jo olemassa. Syy: paketteja ei koskaan korvata. Ratkaisu: anna uudelle paketille toinen id.

Oire: oikeusvirhe. Syy: avain ei ole omistajan tekemä admin-avain. Ratkaisu: luo admin-avain omistajana ja käytä sitä.

Asiantuntijoille

Rajat ja hylkäykset

Raja	Arvo
format	holyarrs-data-pack
version	1
Paketin tai viennin koko	256 KiB
Valintasäännöt	32
Nimeämisjoukot	8
Julkaisunimen tarkistukset	256
Id:t	1–64 merkkiä: pieniä kirjaimia, numeroita, pisteitä, ajatusviivoja, alaviivoja. Alkavat ja päättyvät kirjaimeen tai numeroon
Käyttöönoton pyynnön runko	16 KiB

Paketti hylätään, jos siinä on päällekkäisiä tai tuntemattomia kenttiä, ylimääräistä JSONia lopun jälkeen, tuntemattomia laatu- tai ominaisuusnimiä, virheellisiä nimeämissanoja, muu versio kuin 1 tai näiden rajojen ylittäviä arvoja. Jokainen julkaisunimen tarkistus ajetaan HolyArrsin jäsentimen läpi, ja sen on täsmättävä jokaiseen odotettuun tietoon.

Paketin rakenne

Kenttä	Sisältää
format, version, id, name	Pakollinen otsikko
pick_rules	Jokaisella on id, name, kinds ja rules (vaiheet, ominaisuudet, kokorajat, protokolla, kieli, järjestys)
naming	Jokaisella on id, name ja patterns (yllä luetellut nimeämisasetukset)
release_tests	Jokaisella on id, name, release_name, hints ja expected (laji, laatu, resoluutio, lähde, codec, liput)

Reitit ja vastaukset

Reitti	Onnistuminen	Hylkäys
POST /api/v1/data-packs/validate	200 ja valid sekä yhteenveto	400 virheellinen, 413 liian suuri
POST /api/v1/data-packs	201 ja yhteenveto, tila inactive	409 id on jo olemassa, 400, 413
GET /api/v1/data-packs	200 ja data_packs
GET /api/v1/data-packs/{id}	200 ja paketin JSON	404
GET /api/v1/data-packs/{id}/preview	200 ja approval_hash	400 kaikista muista kyselyistä kuin pick_rule_id ja naming_id, 404
POST /api/v1/data-packs/{id}/apply	200 ja pack_id, pick_rule_ids, naming_id	409 vanhentunut, 400, 404

Aiheesta lisää

• Metadata
• Kirjasto