Sidestruktur

Undersider for systemer forvaltes av teamet som eier systemet. Eier skal beskrives i CODEOWNER.

Undersidene for api-tjenester skal alltid ha følgende sider i sidestruktur i en mappe under hovedsiden for Matrikkelen eller Grunnboken.

Navn i menystrukturen	sidebar_position	Filnavn	Henvisning?	Beskrivelse
Tjenestenavn	-	index.mdx	Nei	Kort beskrivelse av systemet
-	2.0	om-tjenesten.mdx	Nei	Beskriver hvilke data tjenesten leverer og hvilke ulike miljøer som finnes. Husk tilbakelinking på miljø fra fellessiden Testmiljøer.
Vilkår	2.1	vilkaar.mdx	Ja	Forklarer om vilkår, søknad og avtaleinngåelse utover hovedsiden
Status og SLA	2.3	status.mdx	Ja	Forklarer om SLA, statusvarsling og oppetider der det avviker fra hovedsiden
Tilgangsstyring	2.4	Nei	Hvordan brukere får tilgang til tjenesten, skal ikke inneholde informasjon fra vilkår
Rettighetspakker	-	Nei	Rettighetspakker dersom det er aktuelt
Forklaring av datafeltene		Nei	Datamodeller, begreper som forklarer informasjon i tjenesten
API (tidligere Hente data)				OBS: Spesialbehandles, se "Sidestruktur under API" under for mappenivå
Versjonering	2.9		Ja	Utfyllende utover hovedsiden om versjonering av tjenesten

Henvisning til hovedsiden skal være med link til tilsvarende side på nivået over. Dersom man har avvik eller tileggsinformasjon som er relevant for denne tjenesten/APIet, skal de dokumenteres under egen overskrift eller paragraf.

For eksempel:

# Status og SLA
Denne tjenesten følger informasjonen gitt <link-til-overordnet-side> med avvikene beskrevet under.

## Avvik fra standard SLA
Tjenesten er bare oppe i arbeidstid. Ingen beregninger knyttet til tilgjengelighet.

Dersom man har flere undersider man ønsker å lage bør disse være under "Versjonering" i menyen slik at man kjenner seg igjen.

Sidestruktur under API

For å danne en sidestruktur under API, anbefaler vi å opprette følgende hierarki

endepunkter
- _category_.json
- api-1-name.mdx
- api-2-name.mdx

Innholdet i category.json er som følger

{
    "label": "API",
    "position": 3,
    "link": {
        "type": "generated-index",
        "description": "Relevant beskrivelse"
    }
}

Dersom apiet har en lenke til en openapi-definisjon man vise denne på følgende måte i api-2-name.mdx.

import { Tabs, TabsContent, TabsList, TabsTrigger } from '@kvib/react'
import { Swagger } from '/src/components/SwaggerV2'

<Tabs defaultValue="tab0" w="100%">
    <TabsList>
        <TabsTrigger value="tab0">Swagger (OpenAPI)</TabsTrigger>
    </TabsList>
    <TabsContent value="tab0">
        <Swagger url="_api-1-openapi-url_" />
    </TabsContent>

</Tabs>

Eksempler

Sidene under Utlevering av egenregistert data her er et godt eksempel.