search

Informasjonsforvaltning / fdk-issue-tracker

An issue tracking repository for data.norge.no
1 stars 0 forks source link

Oppdatere dokumentasjonssider, evt. varsle på doc sites, i forkant av endringer #940

Open marittor opened 7 months ago

marittor commented 7 months ago

📖 Dokumentasjon

Kontekst/Tjeneste: Datasett og begreper

Hvem er dokumentasjon for: Eksterne

Vi har nylig hatt issues med å kjøre spørringer mot APIene som er listet som eksempler her: https://informasjonsforvaltning.github.io/felles-datakatalog/begrepskatalog/api/

og denne: https://informasjonsforvaltning.github.io/felles-datakatalog/datasett-katalog/api/

Fikk 403-melding. Kan dere ta en gjennomgang og sørge for at disse nå er oppdatert? Evt lage rutiner på å varsle (direkte på doc-site) før endringer skjer.

Huskeliste for dokumentasjon

Beskrivelse av tjeneste: Henvendelsen gjelder en bug eller forbedring

marittor commented 7 months ago

Mulig dette burde vært meldt som en bug, men da får dere bare flytte :)

KjerstiSteien commented 4 months ago

Bør løses som del av arbeidet vi gjør med informasjonsforvaltning.github-siden. @NilsOveTen: Sørger du for at informasjonen på disse sidene stemmer? @KurtStian ser du på rutiner ved endring av endepunkt?

AinaEngen commented 3 months ago

@NilsOveTen - har vi sjekket at informasjon på disse sidene stemmer? @KurtStian - rutine ved endring av endepunkt, er det noe du holder tak?

NilsOveTen commented 3 months ago

@NilsOveTen - har vi sjekket at informasjon på disse sidene stemmer? @KurtStian - rutine ved endring av endepunkt, er det noe du holder tak?

Det var dokumentasjon for et gammelt API, har fjerna de og erstattet med sider for de nye APIene: https://informasjonsforvaltning.github.io/data.norge.no/search

KjerstiSteien commented 1 month ago

Mener likevel vi må se på dette skikkelig, for å sikre at vi håndterer forvaltningen av API-ene våre på en god måte fremover.

Foreslår følgende aktiviteter:

  1. Vi går gjennom API-ene våre og avgjør hva slags bruk de er ment for.
  2. API-ene beskrives i API-katalogen.
  3. Vi lager en rutine for varsling før endringer av APIer som er rettet mot eksterne.
  4. Vi må vurdere hvordan vi håndterer API-er som er tilgjengelig eksternt, men som ikke er rettet mot eksterne.