felleslosninger / docs

Prosjekt for teknisk dokumentasjon av FEL's fellesløsninger. Publisert via Github Pages og Jekyll på docs.digdir.no

Teknisk dokumentasjon av Digitaliseringsdirektoratet fellesløsninger

Dette er kildekoden til den tekniske dokumentasjonen for Digitaliseringsdirektoratet fellesløsninger.

Du finner en formatert versjon av denne dokumentasjonen på følgende nettside: https://docs.digdir.no

docs's Issues

Maskinporten: Lenke til skjema for tildeling av prefix er død

Lenke til skjema som benyttes for manuell tildeling av prefix er død (https://forms.office.com/Pages/ResponsePage.aspx?id=D1aOAK8I7EygVrNUR1A5ka_Oknk2ND5DhEKnqlTuZMlUMVNWWVYwSlhTWlpRTjQwWEVDS09EUFVWWS4u).

https://github.com/felleslosninger/docs/blob/gh-pages/_docs/Maskinporten/maskinporten_guide_apitilbyder.md#1-manuell-tildeling-av-prefix

Feil i OpenAPI/Swagger dokumentasjon for integrasjoner.difi.no Scopes API

Hei 😄

Litt usikker på om issuen passer i dette repoet. Gjerne flytt eller steng den om den ikke passer.

Jeg har jobbet med å konsumere integrasjoner/Scopes API, for ett kundeprosjekt i offentlig sektor. Også dokumentert her.

Veldig fint at API'et er dokumentert med OpenAPI. Jeg ønsket å bruke dette til code generation til http klient i csharp.
Bare ett lite problem - query parameterene i OpenAPI skjemaet er ikke definert helt etter boka.
Hvis man trykker "Try it" på en av endepunktene med query parametre ser dere at query parametere dukker opp 2 ganger i request URL:

Det samme gjør at den genererte http klienten min forsøker å sende forespørselen sin til feil url - "{?inactive%7D=" kommer med bokstavlig.
Ser ut som problemet er at query parameterene er blitt med i paths i OpenAPI json filen.

test test

test

Link til KRR OpenAPI dokumentasjon krever autentisering.

Jeg prøver å følge linken til OpenAPI dokumentasjonen av KRR APIet her: https://difi.github.io/felleslosninger/oppslagstjenesten_rest.html#endepunkt men blir stoppet med en 401 og responsen:

{"status":401,"error":"Unauthorized","error_description":"Full authentication is required to access this resource","correlation_id":"47ba710c-c656-4616-bf2e-1eb5638d509e","timestamp":"2020-03-05T09:29:51.971Z"}

Direktelink til siden som krever autentisering: https://oidc-ver2.difi.no/kontaktinfo-oauth2-server/rest/swagger-ui.html#/Personer

Feil link? Feil oppsett?

Ødelagte lenker

Lenke https://samarbeid.difi.no/difis-felleslosninger/tilleggstjenester er gjengitt flere ganger i dokumentasjonen, men resulterer i en 404 på Difi sine nettsider.

brødsmuler el. lignande slik at ein kan ha fleire nivå i sidehierarkiet utan å "miste" kvar ein kom fra

hadde vært veldig fint med brødsmuler el. lignande slik at ein kan ha fleire nivå i sidehierarkiet utan å "miste" kvar ein kom fra

slik det er no , hvis ein linker til noko som ikkje skal være i hovedmenyen, så blir ein med ein gong litt lost

feil lenke i https://docs.digdir.no/resources/begrep/sikkerDigitalPost/forretningslag/Dokumentformat/

lenke er feil her https://docs.digdir.no/resources/begrep/sikkerDigitalPost/forretningslag/Dokumentformat/

ELMA sin swagger-spesifikasjon som nedlastbar fil

Det hadde vært veldig kjekt for automatisering om selve swagger-spesifikasjonen for ELMA lå som en egen fil, og ikke som en string i html'en.

Integration swagger link is dead

The link to the swagger documentation of the integration API does not work.
https://integrasjon-ver2.difi.no/swagger-ui/

OpenAPI-dokumentasjon
REST-grensesnittet er dokumentert her.

{
  "status":401,
  "error":"Unauthorized",
  "error_description":"Full authentication is required to access this resource",
  "correlation_id":"5415dd52-5dcd-438e-be61-b28f79087888",
  "timestamp":"2021-11-04T19:20:52.035Z"
}

Google indekserer md-fila

google indekserer feks https://github.com/felleslosninger/docs/blob/gh-pages/_docs/eFormidling/Selvhjelp/eformidling_selfhelp.md.

Sjekke ut om indeksering kan kuttes ut

legge til Altinnboks på framsida

lenke til https://altinn.github.io/docs/

Dokumentere/spesifisere authentication for swagger/openapi

Jeg sliter litt med authentication mot API'et som er spesifisert på https://difi.github.io/felleslosninger/elma_swagger.html

Selve swagger-spec'en sier ingen security schemes, så jeg forsøkte med basic auth manuelt via Authorization: Basic <base64>, men blir uansett kun redirected til /login som virker litt rart for et API? Mangler det noe på basePath?

(jeg går mot https://smp.difi.no hvis det har noe å si hvilket miljø)

Er swagger-apiet på noen måte relatert til https://smp.difi.no/rest/resources/docs/index.html?

mulig endring: overvåking av endring på side

overvåking av endring på side.

alt 1 funksjonalitet innebygd i web-sida
alt 2: bruke github direkte

Interne mottakere og avsendere i arkivmelding

Hvordan håndtere interne avsendere og mottakere?
Eksempel her fra geointegrasjon arkiv på intern mottaker. Disse feltene finner en ikke i arkivmeldingen. Er de utenfor scope?

korrespondansepart	avsmot (am)	KAN	NEI	Mottagere av notatet. Minimum en for N, valgfri for X.
korrespondanseparttype	amIhtype	JA	NEI	Intern mottaker
administrativEnhetInit	amAdmkort	JA	NEI	«Initialer» til administrativ enhet journalposten skal sendes til.
saksbehandlerInit	amSbhinit	JA	NEI	Initialer til saksbehandler journalposten skal sendes til.

installere verktøy på docs som kan varsle om døde lenker?

innspel:

er det mulig å installere et verktøy på docs som kan varsle om døde lenker?

Burde man hatt en crawler som leter etter linker som ikke fungerer? Og la den gå over alle nettstedene?

Mulig feil i KRR attribrutter dokumentasjon

på Atribrutter i KRR siden https://docs.digdir.no/docs/Kontaktregisteret/krr_attributter står det under attributten mobiltelefonnummer at en mulig respons er Mobilnummer. Dette virker som det er en typo.

jekyll klarar ikkje å rendere mermaid-javascript (diagram)

ser ut som at vi må få tak ein Jekyll-lege, docs/jekyll klarar ikkje å rendere mermaid-javascript (diagram) i markdown lenger (gamle sider som er generert av jekyll i Digdir Docs er ok)

div lenker feil under ID-porten SAML

saml_funksjonell.md
saml_teknisk_innlogging.md

m.fl.

rette opp i dette (er hardlenka mot https://difi.github.io/idporten-integrasjonsguide)

eFormidling Ipunkt - Oppdater info om anbefalt Java-versjon (11 og JRE)

Kontekst

Dok ber om Java 8 (JRE? JDK?) og "Java Cryptography Extension (JCE)".

• https://docs.digdir.no/assets/search.html?query=adopt

Support har bekreftet at man kan bruke Java 11 JRE. Seneste versjon finner man her:

• https://adoptium.net/temurin/releases/?os=windows&arch=x64&package=jre&version=11

Av det jeg kan lese trenger man ikke "Java Cryptography Extension (JCE)" lenger.

Forespørsel

Oppdater dok om anbefalt Java-versjon til å være versjon 11 og JRE, samt fjern info om "Java Cryptography Extension (JCE)".

• Versjon 21 i fremtiden når: digdir/roadmap#65

menyen viser ikkje lenger kva side du står på?

spm:

har det skjedd noko der no som gjer at menyen ikkje lenger viser kva side du står på ?

Td. https://docs.digdir.no/docs/idporten/oidc/oidc_protocol_nye_idporten ekspanderer ikkje menyen. Eg meiner dette har fungert tidlegare?

(intern ref. digdir slack #generelt, 10.05.2022)

Content-Type in invalid in many of the responses

I am using the swagger files to generate client code. The produce field i set to */* in many of the response, and the actual content-type of the response sometimes not correct.

The DELETE /clients/{id} for instance returns text/plain; charset=UTF-8 as a content-type.

This makes it very hard to rely on the swagger files to generate client code.

Maskinporten-client - bruk av proxy

Maskinporten-client ser ut til å mangle støtte for konfigurering av proxy.
I noen driftsmiljøer er dette en nødvendighet, så det hadde vært fint å få lagt inn.

legge til datasett med syntetiske brukere i krr_testbrukere.md

Her: https://github.com/felleslosninger/docs/blob/gh-pages/_docs/Kontaktregisteret/krr_testbrukere.md

kun datasett med ekte fnr pr i dag

Feil i lenke

Den nederste lenka på https://docs.digdir.no/docs/eInnsyn/index.html «Installasjonsveiledning for integrasjonspunktet finner du her» peikar til ei side som ikkje eksisterer (https://docs.digdir.no/docs/eFormidling/installasjon/eformidling_download_ip)

lengde tegn - dpi

legge inn om dette:

Størrelse på filer er maks 30mb: https://samarbeid.difi.no/hvor-stor-kan-en-forsendelse-vaere-i-digital-postkasse
Lengde på filnavn: Tittel/filnavn er nå utvidet til 255 tegn (i henhold til noark standard). For vedleggstittel er lengden derimot fremdeles 100 tegn. Dette er spesifisert i xsd-skjema:
Hoveddokument: https://github.com/difi/begrep-SikkerDigitalPost/blob/master/xsd/sdp-felles.xsd (fra linje 85 om tittel)
Vedlegg: https://github.com/difi/begrep-SikkerDigitalPost/blob/master/xsd/sdp-manifest.xsd (fra linje 38 om Navn på filen i dokumentpakken)

eFormidling Ipunkt - Stopper Ipunkt om man stopper KOSMOS-tjenesten?

Bakgrunn

Det hadde vært kjekt å vite om å stoppe Windows-tjenesten kosmossvc også stopper Ipunkt, f.eks. i forbindelse med oppgradering av Java-installasjon. Tenker da på når man kjører KOSMOS som en Windows-tjeneste, som også orkestrerer Ipunkt, ref:

• https://docs.digdir.no/docs/eFormidling/installasjon/automatisk_oppgradering#k%C3%B8yra-som-windows-teneste

Om det er nok å stoppe KOSMOS-tjenesten med f.eks. PowerShell Stop-Service -Name 'kosmossvc', oppdatere Java, så PowerShell Start-Service -Name 'kosmossvc', hadde det gjort prosessen rask og enkel.

Ettersom jeg ikke finner info på dette tenker jeg heller å sette kosmossvc service startup type til "Manual", reboot, oppdatere Java, sett kosmossvc startup type tilbake til "Automatic", start kosmossvc.

• Edit: Gjorde dette i går ^, funka bra.

Forespørsel

Legg til info i dok eller F.A.Q:

• Konkret: Stopper Ipunkt om man stopper KOSMOS-tjenesten kosmossvc?
• Generell info om prosedyre for Java-oppdatering hadde vært nyttig.
  • Relatert: #376

rette logo på https://docs.digdir.no/eformidling_nm_restdocs.html

https://docs.digdir.no/eformidling_nm_restdocs.html bør inn under profilen til Docs

ligg på https://github.com/felleslosninger/efm-integrasjonspunkt/tree/development/integrasjonspunkt/src/main/asciidoc og er i AsciiDoc, ikke markdown.

Tilbakemeldingar Utvida møteavlevering

Tilbakemeldingar på https://difi.github.io/felleslosninger/einnsyn_utvida_moeteavlevering.html

Elma Swagger spec har feil `in` på noen parametere

 "/api/organizations/{scheme}::{value}/processes": {

skulle tilsi at scheme og value skal ha in: "path", men det ser ut til å være in: "query" på begge. Da blir klienter forvirret når man genererer de.

Ved lenking til eit anker havner ein under tittelen til ankeret

Når ein i dag lenker til eit anker på ei side, så havner ein under tittelen til ankeret istadenfor akkurat på ankeret, slik at det blir litt vanskelig å forstå kontekst.

eks:
https://docs.digdir.no/docs/Maskinporten/maskinporten_sjolvbetjening_api#registrere-klient-som-bruker-egen-n%C3%B8kkel , denne skulle gjerne vist overskrifta lenka går til og ikkje berre under overskrifta