H

10 Messages

 • 

520 Points

Tuesday, November 12th, 2024 10:38 AM

Asset and Attribute API Calls deprecated typeIds (the list)

Noticed in the REST API documentation that the typeIds now say depracated as well as typeId and that there's now typePublicIds.

Did I miss any comms about this?

161 Messages

 • 

550 Points

3 months ago

I saw this, too, in the Java API, and was not impressed.

FWIW, I've always recognized the Collibra API as super-well designed in years past. It's accessible, predictable, and pretty reliable. 👍 

Lately, however, I've had some concerns.

First, we had to convert our workflows to accommodate a move from UUIDs to much more error-prone Strings. 🤮 This seemed like a terrible design decision, as workflow developers would always have to explicitly convert the Strings to UUIDs anyway to leverage the API.

But deprecating UUID type specification? This is much, much worse.😱 With hundreds of workflows, this deprecation implies a conversion project that my organization simply would not be able to undertake.

Perhaps someone from Collibra can chime in?

27 Messages

 • 

2.3K Points

@tomfriesen​ Did you receive any feedback by Collibra?

14 Messages

 • 

100 Points

Thank you for your feedback. My name is Roeland Herrebosch, I am a product manager at Collibra and I will try to provide some clarity.

When we started the introduction of the public id concept the goal was to have a more human-readable technical identifier that customers can use in workflow scripts or custom integration code. When your code logic needs to execute different actions for specific types, having UUIDs in your code makes it harder for a human developer to understand what type of content they are processing.

Initially our goal was to let public id fully replace UUID so we deprecated the typeId fields. Based on feedback we are changing our decision though. There are cases where you get the UUID of a type just to pass it to the next method, irrespective of what asset type/attribute type/relation type/... it is. In such case the actual value (whether it is a UUID or a public id) is only 'seen' by a computer and it does not make sense to force passing such interaction via public id. Therefore we decided to keep typeId and publicId fields in parallel. In the API documentation that gets released with the 2025.02 release, we will remove the deprecation  notices on the relevant fields.

(edited)

Loading...