Page History
...
Service udstil type | <Angiv typen, f.eks. DGWS, IDWS, ...> |
Krævede adgange | <Angiv adgange som er nødvendige for anvendere for at kunne benytte servicen/komponenten> |
Whitelisting | Whitelisting kræves for IP-adresser, der skal have adgang til GM-CMS. |
Krævet sikkerhedsniveau | <Angiv krav til authentication for at kunne bruge servicen/komponenten> |
Forudsætninger for anvendelse | <Angiv forudsæntninger som er nødvendige for at kunne bruge servicen/komponenten, eventuelle nødvendige kald til andre services, etc.> |
Logning | <Angiv om og hvad der logges> |
<Eventuel nærmere introduktion>
XXXX
Definitioner og referencer
| Reference | Beskrivelse |
|---|---|
CMS | Content Management System |
GM | Graviditetsmappen |
BFF | Backend for frontend |
Adgang, brug og snitflader
Adgang
<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | <Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.> |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
Brugertyper (roller)
Snitfladebeskrivelse og brug
<Beskrivelse af Snitfladerne, samt den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever.>
Strapi snitflade
Strapi CMS'en udstiller en række endpoints til at hente de definerede indholdstyper. Alle API-endpoints er offentligt tilgængelige, hvilket betyder, at det ikke er nødvendigt at sætte en authentication header på anmodningerne.
Indholdstyper
Jf. use cases skal følgende indholdstyper konfigureres i GM-CMS.
Indholdstype | Beskrivelse | Relation | id |
Kategori | Indeholder titel og tilhørende artikler | Kategori “tilhører flere” artikler | category |
Artikel | Indeholder titel, beskrivelse, tags, boolean til angivelse af om artikel skal skjules på forside, samt tilhørende kategorier og sektioner | Kategori ”har flere” artikler Artikel “tilhører flere” sektioner | article |
Sektion | Indeholder titel, tekst, liste af ugenumre i graviditet/efter fødsel hvor sektionen er relevant, samt tilhørende artikler | Artikel “har flere” sektioner | section |
Tjekliste | Indeholder titel, beskrivelse, samt tilhørende tjektlistepunkter | Tjekliste ”tilhører flere” tjeklistepunkter | checklist |
Tjeklistepunkt | Indeholder titel, beskrivelse, samt tilhørende tjektliste | Tjekliste “har flere” tjeklistepunkter | checklist-point |
Ordforklaring | Indeholder ord og ordforklaring | glossary-term | |
Tekst | Indeholder titel, tekst, beskrivelse og unikt API-navn. Bruges til at oprette tekster om samtykkeerklæring, databeskyttelse osv. | text | |
FAQ | Indeholder spørgsmål og svar | faq |
Strapi endpoints
Indholdstype | Endpoirt |
Kategori | /api/categories |
Artikel | /api/articles |
Sektion | /api/sections |
Tjekliste | /api/checklists |
Tjeklistepunkt | /api/checklist-points |
Ordforklaring | /api/glossary-terms |
Tekst | /api/texts |
FAQ | /api/faqs |
...
Eksempelvis for at få alle artikler, samt relaterede kategorier og sektioner kaldes:
| /api/articles?populate=* |
|---|
Eksempler på atrapi request/responses
TODO
Meilisearch snitflade
Meilisearch anvendes til at søge i artikler CMS'en udstiller en række endpoints til at hente de definerede indholdstyper. Alle API-endpoints er offentligt tilgængelige, hvilket betyder, at det ikke er nødvendigt at sætte en authentication header på anmodningerne.
Generelle koder, værdier, etc.
<Angiv eventuelle generelle koder, værdier, etc>
Fejlbeskeder
Herunder er nogle af de mest almindelige fejlbeskeder og deres årsager.
...