arkivverket / noark5-tjenestegrensesnitt-standard

6 stars 11 forks source link

Ta i bruk RFC 6902 for flytting av objekter #320

Open tsodring opened 5 months ago

tsodring commented 5 months ago

       Prosjekt  NOARK 5 Tjenestegresesnitt
       Kategori  Noark 5.5.0 TG versjon 1.1
    Alvorlighet  kommentar 
   Meldingstype  trenger klargjøring
Brukerreferanse  tsodring
    Dokumentdel  # [Kap 6. Oppdatere objekter (Update)](https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/blob/master/kapitler/06-konsepter_og_prinsipper.rst#oppdatere-objekter-update)
     Sidenummer  # n/a
    Linjenummer  # n/a

Beskrivelse

Bruken av PATCH i tjenestegrensesnittet følger ikke en standardisert tilnærming. Det er kun en PATCH forespørsel og ingen videre besrkivelse. RFC 6902 (JSON Patch) har en standardisert beskrivelse for å flytte noe.

Ønsket endring

Det er ønskelig at TG i neste versjon tar inn støtte for RFC 6902.

PATCH til https://n5.example.com/api/arkivstruktur/Dokumentbeskrivelse/1fa94a89-3550-470b-a220-92dd4d709044

   {
       "op": "move",
       "from": "https://n5.example.com/api/arkivstruktur/registrering/cf8e1d0d-e94d-4d07-b5ed-46ba2df0465e",
       "path": "https://n5.example.com/api/arkivstruktur/registrering/7f000101-9031-1f4c-8190-316f95fe0000"
   }

Det er en tydelig beskrivelse av hva som er ønsket endring nå arkivkjernen mottar en slik nyttelast og mer forstålig enn dagens nyttelast.

Det er viktig å merke seg at flytting av feks en saksmappe (som er tilkoblet en primær klasse), fra en arkivdel til en annen, ikke kan skje dersom den andre arkivdelen ikke har samme klasse som en del av sin primær klassifikasjonssytem. Tilsvarende så kan det være utfordringer rundt saksnummer ved en slik flytting. En slik flytt funksjonalitet er viktig for å implementere periodisering.

Det er også verdt å merke at dersom vi tar inn RFC 6902, så åpner vi får muligheten til å kunne kopiere objekter også. Forløpig ser jeg ikke behov for å støtte operasjonen som test, add (legg till), remove (fjern), replace (erstatt).

tsodring commented 5 months ago

See for proposed text.