Collibra JAVA API release notes
Since there are no official release notes, here is my version.
To reproduce, you can just download whatever collibra api jar version from the downloads page, and follow those steps in a shell terminal.
It’s not a very fast method, it will take 10min or so per jar, but hey, it gets the job done
Given two versions 2022.01.0-48 and 2023.04.0-25:
for VER in 2022.01.0-48 2023.04.0-25; do
jar -tf dgc/dgc-core-${VER}-apiv2.jar|\
grep "\.class"| grep -v '\$' | while read i; do
echo $i;
mkdir -p "dgc-${VER}/${i%/*}";
javap -cp dgc/dgc-core-${VER}-apiv2.jar $( echo $i|sed 's;/;.;g'|sed 's/\.class//' ) > "dgc-${VER}/${i}";
done;
done
From there, you can diff the two folders
Result (sample)
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/assignment/ScopeApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/assignment/ScopeApi.class\r"
5a6
+ public abstract void removeScope(com.collibra.dgc.core.api.dto.assignment.RemoveScopeRequest);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/breadcrumb/BreadcrumbApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/breadcrumb/BreadcrumbApi.class\r"
6d5
- public abstract java.util.List<com.collibra.dgc.core.api.dto.breadcrumb.AssetBreadcrumb> getAssetTypeBreadcrumb(java.util.UUID);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/file/FileApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/file/FileApi.class\r"
3a4
+ public abstract com.collibra.dgc.core.api.model.file.FileInfo addFile(java.lang.String, java.io.File, boolean);
4a6
+ public abstract java.io.File getFileDirectory();
5a8,11
+ public abstract byte[] getFileContent(java.util.UUID);
+ public abstract com.collibra.dgc.core.api.model.file.FileInfo getFileInfoFromUrl(java.lang.String);
+ public abstract java.lang.String getFileName(java.util.UUID);
+ public abstract void cleanTemporaryDirectory(long);
7a14
+ public abstract void deleteFile(java.util.UUID);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/instance/AssetApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/instance/AssetApi.class\r"
9c9
- public abstract com.collibra.dgc.core.api.dto.PagedResponse<com.collibra.dgc.core.api.model.instance.Asset> findAssets(com.collibra.dgc.core.api.dto.instance.asset.FindAssetsRequest);
---
+ public abstract com.collibra.dgc.core.api.dto.CursorPagedResponse<com.collibra.dgc.core.api.model.instance.Asset> findAssets(com.collibra.dgc.core.api.dto.instance.asset.FindAssetsRequest);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/instance/AttributeApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/instance/AttributeApi.class\r"
8c8
- public abstract com.collibra.dgc.core.api.dto.PagedResponse<com.collibra.dgc.core.api.model.instance.attribute.Attribute> findAttributes(com.collibra.dgc.core.api.dto.instance.attribute.FindAttributesRequest);
---
+ public abstract com.collibra.dgc.core.api.dto.CursorPagedResponse<com.collibra.dgc.core.api.model.instance.attribute.Attribute> findAttributes(com.collibra.dgc.core.api.dto.instance.attribute.FindAttributesRequest);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/instance/CommunityApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/instance/CommunityApi.class\r"
10c10
- public abstract com.collibra.dgc.core.api.dto.PagedResponse<com.collibra.dgc.core.api.model.instance.Community> findCommunities(com.collibra.dgc.core.api.dto.instance.community.FindCommunitiesRequest);
---
+ public abstract com.collibra.dgc.core.api.dto.CursorPagedResponse<com.collibra.dgc.core.api.model.instance.Community> findCommunities(com.collibra.dgc.core.api.dto.instance.community.FindCommunitiesRequest);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/instance/ComplexRelationApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/instance/ComplexRelationApi.class\r"
7c7
- public abstract com.collibra.dgc.core.api.dto.PagedResponse<com.collibra.dgc.core.api.model.instance.ComplexRelation> findComplexRelations(com.collibra.dgc.core.api.dto.instance.complexrelation.FindComplexRelationsRequest);
---
+ public abstract com.collibra.dgc.core.api.dto.CursorPagedResponse<com.collibra.dgc.core.api.model.instance.ComplexRelation> findComplexRelations(com.collibra.dgc.core.api.dto.instance.complexrelation.FindComplexRelationsRequest);
diff -Nr "dgc-2022.01.0-48/com/collibra/dgc/core/api/component/instance/DomainApi.class\r" "dgc-2023.04.0-25/com/collibra/dgc/core/api/component/instance/DomainApi.class\r"
8c8
- public abstract com.collibra.dgc.core.api.dto.PagedResponse<com.collibra.dgc.core.api.model.instance.Domain> findDomains(com.collibra.dgc.core.api.dto.instance.domain.FindDomainsRequest);
---
+ public abstract com.collibra.dgc.core.api.dto.CursorPagedResponse<com.collibra.dgc.core.api.model.instance.Domain> findDomains(com.collibra.dgc.core.api.dto.instance.domain.FindDomainsRequest);
arthurburkhardt
Posted 3 years ago · Edited 1 year ago·Last reply 3 years ago
2 comments
stefan_busch
·3 years ago · EditedHi Arthur,
This is actually a neat thing. But I do hope that they give us a warning before doing any breaking changes.
Best regards,
Stefan
arthurburkhardt
OP3 years ago · EditedActually, I just discovered a section of the release notes I hadn’t seen before: ref_dgc-api-compatibility (collibra.com)
I still won’t provide info of what has changed from one version to the next, but still is a decent overview of API changes.