Skip to main content
A
aamanl

26 Messages

Sunday, February 20th, 2022 4:25 PM

Complete Documentation for Collibra Springboot Integration Library

Is there a complete documentation for the Collibra SpringBoot Integration Library available, apart from the PDF with examples that is provided in the Collibra Marketplace? It is hard to see how to compose items such as FindRelationQueryParams, etc.
It is also difficult to see the precise mapping of the REST APIs to the classes and methods in this library.

Questions

 • 

Updated 

3 years ago

140

1

0

0

arthurburkhardt

1.2K Messages

3 years ago

I think this is simply an openAPI-generated java code. The integration library ships with the attached javadoc, so you can get the information in eclipse.
The class is com.collibra.marketplace.library.generated.core.api.RelationsApi and it’s just a hashmap of all the query parameters you can pass to the rest API

  public static class FindRelationsQueryParams extends HashMap<String, Object> {
    public FindRelationsQueryParams offset(Integer value) {
      put("offset", EncodingUtils.encode(value));
      return this;
    }

image

3

0

aamanl

26 Messages

Thank you, I was indeed able to compose the query and get Results, but it does appear the javadoc is not fully documented, a few classes/functions have missing documentation.

For reference, here is the working sample code:

 FindRelationsQueryParams queryParams3 = new FindRelationsQueryParams();
 //TABLE_CONTAINS_COLUMN
 queryParams3.put("relationTypeId", UUID.fromString("00000000-0000-0000-0000-000000007042"));
 queryParams3.put("targetId", relTable.getTarget().getId());
 List<RelationImpl> relsCols =   relApi.findRelations(queryParams3).getResults();

Like

Reply

3 years ago

0

arthurburkhardt

1.2K Messages

Well, if the javadoc comes from the openAPI generated code, it should be complete.
What are you missing? I’m not sure I understand what is lacking from the sample code you shared.

Like

Reply

3 years ago

0

aamanl

26 Messages

The code was just for reference, I will see if I can find methods/classes that had insufficient documentation, but thank you for the response/guidance.

Like

Reply

3 years ago

0

Related Tags

openapi

community-offering

springboot

Related Conversations

Loading...
Loading...

Was this helpful?