Skip to content

Commit

Permalink
Taal consistentie
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenvdlinde committed Jun 24, 2024
1 parent 1fddbfc commit 479c784
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions docs/handleidingen/Architectuur.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,14 @@ De admin UI staat je toe om handmatig publicaties te maken, documenten eraan toe
## De zoek-API
De belangrijkste functie van Open Catalogue is de zoek-API. Deze wordt aangeboden in twee vormen: plain JSON en JSON-LD, en faciliteert de mogelijkheid voor federatief zoeken.

Kernconcepten en richtlijnen:
Gebruikers moeten worden begeleid/geholpen bij het vinden van de juiste informatie. De enorme hoeveelheid gegevens die theoretisch beschikbaar is op Open Catalogue maakt dit een uitdaging. Om deze uitdaging aan te gaan, maken we gebruik van [faceted search](https://www.oxfordsemantic.tech/faqs/what-is-faceted-search#:~:text=Faceted%20search%20is%20a%20method,that%20we%20are%20looking%20for.). Gebruikersinterfaces MOETEN altijd een dynamisch gecreëerde zoekinterface bevatten met behulp van deze faceted search. Zoekfacetten bevatten zowel zoekopties als de verwachte resultaten onder die opties, waardoor gebruikers een goed idee krijgen van hoe ze hun zoekopdracht kunnen aanpassen. Dat betekent ook dat de facetten tijdens of na elke zoekopdracht moeten worden bijgewerkt.
## Kernconcepten en richtlijnen:
Gebruikers moeten worden begeleid/geholpen bij het vinden van de juiste informatie. De enorme hoeveelheid gegevens die theoretisch beschikbaar is op Open Catalogue maakt dit een uitdaging. Om deze uitdaging aan te gaan, maken we gebruik van [faceted search](https://www.oxfordsemantic.tech/faqs/what-is-faceted-search#:~:text=Faceted%20search%20is%20a%20method,that%20we%20are%20looking%20for.).

Dit is waar prestaties een rol spelen. Zoekfacetten worden (optioneel) geretourneerd op de zoek-API, zodat zowel resultaten als facetten in één oproep MOETEN worden verkregen. Je MAG het echter splitsen in twee oproepen (resultaten ophalen en facetten ophalen) als je de facetten direct daarna of asynchroon bijwerkt met het resultaat. Dit kan je een prestatieverbetering van 200 tot 400 ms opleveren. In deze configuratie MOET je echter een laadtoestand op de zoekinterface implementeren totdat beide oproepen zijn voltooid.
Gebruikersinterfaces MOETEN altijd een dynamisch gecreëerde zoekinterface bevatten met behulp van deze faceted search. Zoekfacetten bevatten zowel zoekopties als de verwachte aantallen resultaten onder die opties, waardoor gebruikers een goed beeld krijgen bij hoe ze hun zoekopdracht kunnen aanpassen. Dat betekent ook dat de facetten tijdens of na elke zoekopdracht moeten worden bijgewerkt a.h.v de API.

Bij het bevragen van de zoek-API MOET je je zoekopdracht beperken door catalogi of metadatasets (bijv. WOO Verzoeken) of bij voorkeur beide om te voorkomen dat je een te brede zoekopdracht uitvoert (en daarmee de API overbelast). Het heeft de voorkeur dat de gebruikersinterface klein begint.
Dit is waar prestaties een rol spelen. Zoekfacetten worden (optioneel) geretourneerd op de zoek-API, zodat zowel resultaten als facetten in één bevraging KUNNEN worden verkregen. De zoeken-UI MAG deze echter splitsen in twee bevragingen (resultaten ophalen en facetten ophalen) als de zoeken-UI de facetten direct daarna of asynchroon bijwerkt vanuit de zoeken-API. Dit kan je een prestatieverbetering van 200 tot 400 ms opleveren. In deze configuratie MOET de zoeken-UI echter een laadtoestand op de zoekinterface implementeren totdat beide oproepen zijn voltooid.

Bij het bevragen van de zoeken-API MOET de zoeken-UI de zoekopdracht beperken aan de hand van catalogi of metadatasets (bijv. WOO Verzoeken) of bij voorkeur beide, om te voorkomen dat je een te brede zoekopdracht uitvoert (en daarmee de API overbelast). Het heeft dus de voorkeur dat de zoeken-ui klein begint, bijvoorbeeld in één categorie,catalogi of organisatie.

## Meer over de catalogus
De catalogus functioneert zowel als een [DCAT-catalogus](https://semiceu.github.io/DCAT-AP/releases/3.0.0/#CataloguedResource) als een [FCS Inway]. Dit betekent dat een catalogus slechts bij ÉÉN organisatie kan horen; eigendom van de catalogus wordt geverifieerd door middel van een PKI-certificaat.
Expand Down
4 changes: 2 additions & 2 deletions docs/handleidingen/componenten.puml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cloud "Kubernetes"{

package "Layer 5 (interaction)" {
package "React NL Design" {
[User Interface] as ui
[Search UI] as ui
}

package "Vue NL Design" {
Expand All @@ -43,7 +43,7 @@ package "Layer 2 (API)" as layer2 {

package "Open Catalogi App" {
[Search API] as SearchAPI
[CRUD API] as ObjectsAPI
[Admin API] as ObjectsAPI
}


Expand Down

0 comments on commit 479c784

Please sign in to comment.