This API exposes the internal cache. That means, that instead of querying each dataspace participant individually, clients can use this API to get a consolidated list of catalogs.
When the catalog runtime starts up, the internal cache will be empty. Once the crawlers start to pick up work, and results are coming in, the cache will get populated. This means, during an execution phase, until all crawlers have finished, results returned by this API will be inconsistent!
Future work may add additional endpoints that can be used to determine the status of the FC, i.e. "crawling in progress" or "idle". This information can be used to gauge the stability of the result.
NB: the results returned by this API will be influenced by the access policies configured in remote Target Catalog
Nodes and the participantId that is configured on the FC. Update requests are DSP requests, so all authentication and
authorization mechanisms apply.
Once all catalogs are collected, clients may add additional query parameters to narrow down the search. Please refer to the QuerySpec class for details.
Please also check out this link for the complete OpenAPI documentation.
The Observability API is intended to provide information about the application health to the Docker daemon via Docker health checks and the Kubernetes control plane via Kubernetes Readiness Probes. It is not intended to be reachable from outside the container as it lacks access control.