Skip to content

Document query parameters for federation #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rjzondervan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document query parameters for federation #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/handleidingen/Architectuur.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Wat prestaties betreft, proberen we zo weinig mogelijk op te vragen. Hiervoor pa
- Bij het zoeken naar een specifiek type metadata, bevragen we alleen catalogi waarvan bekend is dat ze die hebben.
- We bevragen OpenCatalogi-installaties in plaats van catalogi.

Om dit te bereiken worden, is er de `_catalogi`-query parameter. In deze parameter geven we de lijst van te lezen catalogi. Dit kunnen interne en externe catalogi zijn. De search controleert vervolgens via de directory welke catalogi er aan een search endpoint hangen (dus per instantie) en geeft dan de `_catalogi`-parameter door aan dit search endpoint. Omdat deze catalogi worden gebaseerd op de listings in de directory, betekent dit dat de bevraagde externe installatie niet gaat doorvragen op andere instanties van OpenCatalogi. Ook wanneer er in de bevraging zelf geen `_catalogi` parameter is gedefinieerd, wordt deze parameter wel samengesteld om alleen de bij een instance geregistreerde catalogi te bevragen, met als resultaat dat ook in deze situatie de bevraging maar één instance diep wordt gedaan.

## Alles up-to-date houden

Wanneer een nieuwe OpenCatalogi-installatie wordt ontdekt, zal de ontdekkende instantie zichzelf kenbaar maken bij de ontdekte instantie en een meldingsabonnement nemen. OpenCatalogi-installaties zullen andere installaties in hun directory op de hoogte brengen wanneer:
Expand Down