search

arkivverket / noark5-tjenestegrensesnitt-standard

6 stars 11 forks source link

List Nikita som referanseimplementasjon #262

Open petterreinholdtsen opened 4 years ago

petterreinholdtsen commented 4 years ago 
       Prosjekt  NOARK 5 Tjenestegresesnitt
       Kategori  Noark 5.5.0 TG versjon 1.0
    Alvorlighet  kommentar
   Meldingstype  utelatt
Brukerreferanse  pere@hungry.com
    Dokumentdel  2
     Sidenummer  3
    Linjenummer  70

Beskrivelse

Tjenestegrensesnittet trenger minst en referanseimplementasjon for å demonstrere hvordan det fungerer. Jeg foreslår å liste opp Nikita som referanseimplementasjon. Kapittel 2 virker å være en god plass å liste opp referanseimplementasjoner.

Ønsket endring

Legg inn et avsnitt/setning i kapittel to om referanseimplementasjoner og pek til Nikitas nettsted https://gitlab.com/OsloMet-ABI/nikita-noark5-core .

monadani commented 4 years ago

Sjekkes ut med Espen Sjøvoll,

petterreinholdtsen commented 4 years ago

[Mona Danielsen]

Hva med å ta med eksempel-serveren til Arkitektum også?

Jeg skulle gjerne hatt to ulike implementasjoner av tjenestegrensesnittet, utformet av to uavhengige grupper. Realiteten er dog at eksempeltjeneren til Arkitektum henger langt etter dagens spesifikasjon og ikke har en aktivt utviklingsgruppe bak seg, og ikke er i en tilstand der den kan være en av disse to.

En referanseimplementasjon må jo være i tråd med spesifikasjonen, eller i det minste være i gang med å bli det, og jeg ser ikke at eksempeltjeneren vil komme dit uten at betydelig finansiering legges på bordet. Vet ikke om noen som er interessert i å finansiere det.

-- Vennlig hilsen Petter Reinholdtsen

monadani commented 4 years ago

@petterreinholdtsen , kan du svare ut dette: Hva menes med objektiv referanseinstallasjon, og hva det innebærer i praksis, hva det skal brukes til etc?

Burde det ikke være en referanseinstallasjon av alle løsninger som er compliant slik at man kan teste etterlevelse?

petterreinholdtsen commented 4 years ago

Litt usikker på hvor begrepet "referanseinstallasjon" kommer fra, men skal forsøke å forklare bedre hva jeg mener. Jeg forsøkte å finne en god definisjon fra IETF på refereranseimplementasjon uten å lykkes, men fant https://en.wikipedia.org/wiki/Reference_implementation som forklarer i grove trekk hva en referanseimplementasjon er for noe.

Konkret vil en erklæring om at Nikita er referanseimplementasjon for Noark 5 Tjenestegrensesnitt gjøre at alle som forsøker å forstå hvordan spesifikasjonen skal tolkes vil se på hvordan ting er løst i Nikita, og Nikitas løsning vil være anbefalt tilnærming hvis spesifikasjonen er uklar. I og med at Nikita er tilgjengelig uten bruksbegresninger, kan alle som ønsker å teste ut tjenestegrensesnittet enten sette opp sin egen instans eller koble seg til testinstansen Nikitaprosjektet har kjørende på https://nikita.oslomet.no/noark5v5/api/ .

Det å ha en referanseimplementasjon dokumenterer i tillegg at spesifikasjonen lar seg implementere, og gjør det klart at alle som vil kan komme enkelt i gang med Noark 5 Tjenestegrensesnitt ved å bruke en fri programvareløsning.

petterreinholdtsen commented 4 years ago

Jeg spurte IETF om de hadde noen gode referanser for definisjonen av referanseimplementasjon, og de fant ikke noe som helt traff det jeg spurte om, men henviste til https://www.rfc-editor.org/rfc/rfc5657.html og https://www.rfc-editor.org/rfc/rfc7942.html som begge forklarer litt om hvordan IETF ønsker ulike implementasjoner av standardene der skal rapportere sin eksistens og omtales i RFC-tekstene. Begge deler er relevant bakgrunnsmateriale her.