Add Target Catalog Node

[c0ball]

Question

Hey everyone,

this is my first time running the Eclipse Federated Catalog, so please bear with me ;)

After setting up a new instance of the Federated Catalog using a mocked identity service I am able to obtain all stored catalogs by sending a Post request to this address http://localhost:8181/api/catalog/v1alpha/catalog/query. As expected, the response was an empty array [] because there are currently no Target Catalog Nodes configured.

My question is: How can I add an existing catalog (Target Catalog Node) for example, one available at federated-catalog.my-org.org to the Target Node Directory?

I would greatly appreciate any guidance or relevant documentation that could help me resolve this issue.

Steps to Reproduce

Steps to reproduce the behavior:

1. Build the FC ./gradlew shadowJar
2. Run the FC java -Dweb.http.catalog.path="/api/catalog" -Dweb.http.catalog.port=8181 -Dweb.http.path="/api" -Dweb.http.port=8080 -jar launchers/catalog-mocked/build/libs/fc-mocked.jar

Context Information

Using latest version of the FC (6a8fda7)

[github-actions[bot]]

Thanks for your contribution 🔥 We will take a look asap 🚀

[bscholtes1A]

Hello
there is already in the code a method you can invoke to add new node in the directory:

FederatedCatalog/spi/crawler-spi/src/main/java/org/eclipse/edc/crawler/spi/TargetNodeDirectory.java

Line 36 in 68c079c

void insert(TargetNode node);

However there is currently no API exposed by the Federated Catalog that enable to call this method.
So for now, you'll have either to create your own API or create a seeding extension that populate the node directory at startup from an external source (for example a json file).

I will create an issue for the creation of an API tough.

Hope this helps.

[c0ball]

Thank you @bscholtes1A , that helped a lot!

I’ve added a new POST endpoint to create a TargetNode.
In the README, I noticed the OpenAPI documentation. Since I’ve included Swagger annotations for my POST endpoint, how can I generate an updated OpenAPI spec? Is there also a way to access it directly in the browser?

Additionally, as a TargetNode requires a supported protocol, is there any documentation or list of the supported protocols available?

Thanks in advance!