When did the API documentation change?

I’m not sure why I didn’t notice this sooner, but I’ve just realised that the Java API documentation no longer shows the parameters that are required anymore for a given API class (at least I can’t see it anymore!).

Has this information been moved to somewhere else/ is there a reason for this I just can’t think of?

As a user that has been using Collibra for a fair while, I can remember the parameters that were marked as “Required” but it makes it quite difficult to train others on the APIs and workflows. For some of the APIs it’s obvious but for others it really isn’t obvious what the Required fields are.

Attached an image of the AddAssetRequest call that used to have TypeId and Name marked as Required

alvinuseree

Posted 4 years ago · Edited 1 year ago·Last reply 4 years ago

4 comments

alvinuseree

OP4 years ago · Edited

Fantastic! If those are the only 3 ways it seems and that information is still exposed in the source code, that should give me enough to raise a support ticket and see where this goes.

Thanks a lot, I’ll update this thread if anything changes.

arthurburkhardt

·4 years ago · Edited

No time to dig into it, but if you look at the class dgc.core.api.dto.instance.asset.AddAssetRequest.java, you will see which parameters are mandatory (aka NotNull).

  @NotNull
  @Size(min = 1, max = 2000)
  @Schema(description = "The full name of the new asset. Should be unique within the domain.")
  private String name;

Now, in order to not have to dive into the source code to get that information, I guess the best thing would be to rebuild the javadoc to show this kind of information.
Possibly a support ticket could be open to request a change in the javadoc build process => it would show again.

alvinuseree

OP4 years ago · Edited

I think this is one of those awkward moments where I’ve picked up on a change from approx a year ago …

@arthur.burkhardt Can you think of any way to determine required parameters without:

a) using the REST API equivalent endpoint to find the required param
b) trial and error?

arthurburkhardt

·4 years ago · Edited

Not sure, but I have copies of the APIs from 2021.05.01 and 2021.06.01.
I could not find those difference, but happy to go over it with you if you want.