fdk-search-service

This service is responsible for searching for all resources in FDK. The service consumes RDF parse events (Kafka) and indexing these resources as documents (SearchObjects) in ElasticSearch.

Open-API spec: https://github.com/Informasjonsforvaltning/fdk-search-service/blob/main/openapi.yaml

About the general SearchObject model

The generalized model is used to represent all resources in FDK, with fields that are common to all resources, and used for searching.

About the SearchResult model

The result of search queries is represented by the SearchResult model. This model contains paginated list of SearchObjects.

Requirements

• maven
• java 21
• docker
• docker-compose

Generate sources

mvn generate-sources    

Run tests

mvn test

Run locally

Start Kafka cluster and setup topics/schemas

Topics and schemas are set up automatically when starting the Kafka cluster. Docker compose uses the scripts create-topics.sh and create-schemas.sh to set up topics and schemas.

docker-compose up -d

If you have problems starting kafka, check if all health checks are ok. Make sure number at the end (after 'grep') matches desired topics.

Start search service

Start search service locally using maven. Use Spring profile develop.

mvn spring-boot:run -Dspring-boot.run.profiles=develop

Produce messages

Check if schema id is correct in the produce-messages.sh script. This should be 1 if there is only one schema in your registry.

sh ./kafka/produce-messages.sh

Search examples

For more usages, see openAPI spec.

Endpoints:

Searching all resources:

URL: https://search.api.staging.fellesdatakatalog.digdir.no/search

Searching specific resources:

URL: https://search.api.staging.fellesdatakatalog.digdir.no/search/[resourceType]

For example:

URL: https://search.api.staging.fellesdatakatalog.digdir.no/search/datasets

Different Payloads:

Search with query:

Payload:

{
    "query": "test",
}

Search with pagination:

Payload:

{
    "pagination": {
        "size": 5,
        "page": 2
    }
}

Search with sorting:

Payload:

{
    "sort": {
        "field": "FIRST_HARVESTED",
        "direction": "DESC"
    }
}

Search with filters:

Payload:

{
    "filters": {
        "accessRights": {
            "value": "RESTRICTED"
        },
        "dataTheme": {
            "value": [
                "REGI"
            ]
        },
        "losTheme": {
            "value": [
                "familie-og-barn"
            ]
        }
    }
}