search

semantic-systems / nfdi-search-engine

A lightweight, KG-driven search engine over different endpoints and APIs
https://nfdi-search.nliwod.org/
MIT License
5 stars 3 forks source link

Integrate ELG API #37

Closed huntila closed 1 year ago

huntila commented 1 year ago

Create a feature for the nfdi-search-engine that searches over European Language Grid using it's public API.

Please look at ELG documentation and ELG-Gitlab.

RicardoUsbeck commented 1 year ago

Here are the steps for integrating ELG API into the nfdi-search-engine:

Familiarize yourself with the nfdi-search-engine codebase to identify the relevant files and functions that need to be modified or added to integrate ELG API.

Go through the ELG API documentation to understand its features, endpoints, and parameters.

Create a new feature in the nfdi-search-engine that specifically searches over the European Language Grid using ELG's public API.

Use the ELG API documentation to determine the necessary parameters for the search query.

Modify the nfdi-search-engine's search function to include the new feature that uses the ELG API to fetch relevant results.

Test the new feature extensively to ensure that it works as intended and does not cause any unexpected errors or issues.

Ensure that the feature is well documented in the nfdi-search-engine's documentation to make it easy for other developers to use and maintain it.

If necessary, collaborate with the ELG-Gitlab team to address any issues or concerns related to the integration of their API.

Once the feature is stable and ready for deployment, submit it for review and integration into the main nfdi-search-engine codebase.