New Topic

Community Topic Question Administration

Eric Hagfors

Yellowfin Support Team

Assigned

Category Administration

Product Version 9.0

API 2.2 vs. 3.0 - where can I find a synopsis of changed keys

Stefan Hall shared this question ago

Awaiting Reply

Hi,

With version 9.14, there is also a new API version 3.0. Unfortunately, you have also renamed individual keys without any real change in functionality.

Without a comparison of the old key with the new key, it is very difficult to find out all the changes. So far I've been bouncing from error message to error message. This must be better with documentation.

An example is the /users endpoint where you have renamed the key “languageCode” to “preferredLanguageCode”. The function behind it remains unchanged.

Which other keys have been renamed?

;) Stefan

Version 9.14

The same question

Replies (6)

Eric Hagfors ●

Hi Stefan,

thanks for reaching out to support with your question. You can see a list of changes to rest endpoints in our 9.14 release notes, see here-

https://wiki.yellowfinbi.com/display/yfcurrent/Release+Notes+for+Yellowfin+9

I could see these included in a 'breaking changes' section for better visibility, let me know if this documentation adjustment sounds like a good way forward here.

Thanks,

Eric

Reply URL

Stefan Hall ●

Hi Eric,

If I had found it there, I wouldn't have opened a ticket or can you find the information about the changed key “languageCode” there? I don't necessarily expect existing keys to be renamed when the API is extended. Especially not without documentation.

Please create a ticket for your backend teams and clarify what else has been changed. I don't have the time to look at every key in comparison between v2.2 and the new v3.0.

Thanks in advance

;) Stefan

URL

Eric Hagfors ●

Hi Stefan,

Thanks for the reply. I've made a product team request for a list of any API "breaking changes" on your behalf in this case. Updates to the task will be provided here as they are available.

Reviewing the existing documentation should be a viable workaround in the meantime, let me know if you have any additional questions.

Thanks,

Eric

Reply URL

Stefan Hall ●

Hi Eric,

checking the documentation is not a valid workaround. Another almost fatal example: Take a look at “Get a user for the purpose of user administration”

In version 2.2, “ipId” was the internal YF ID for a user, “userID” was the external login ID.

In version 3.0, “userID” is the internal YF ID for a user and “userName” is the internal login ID.

Have you noticed that the content and meaning of “userID” has changed completely? If you have an established and tested integration with an HR system, then all existing users are now new in a newly synchronization, a fatal error!

Under no circumstances can it be my job to search for and find all these small hidden changes. I think it's your job to document these things properly in a release. I am already very unhappy with the new release and the way it has been released.

;) Stefan

URL

Eric Hagfors ●

Hi Stefan,

Just wanted to provide an update - documentation on this is being worked on, additionally here is comment from developers on this -

 there are major changes in V3 of the API which is why the major version number was incremented. Existing code should work as the client can explicitly select the version they want to run against.

The client can continue to use v2.2. All they'd have to do is use the v2.2 "Accept" header, which they will have been using already.

Hope this helps, let me know if you have any additional questions.

Thanks,

Eric

Hi Stefan,

Just wanted to provide an update - documentation on this is being worked on, additionally here is comment from developers on this -

 there are major changes in V3 of the API which is why the major version number was incremented. Existing code should work as the client can explicitly select the version they want to run against.

The client can continue to use v2.2. All they'd have to do is use the v2.2 "Accept" header, which they will have been using already.

Hope this helps, let me know if you have any additional questions.

Thanks,

Eric

Reply URL

Stefan Hall ●

Hi Eric,

this is not new information, but version 2.2 is a bit buggy and therefore I would like to use version 3. Unfortunately, this is also quite buggy and apparently not documented in comparison. All in all, this is a great pity.

How long will the missing documentation take?

;) stefan

URL

Eric Hagfors ●

Hi Stefan,

The requested documentation is attached and will be added to the wiki shortly, let me know if you need anything additionally.

Thanks,
Eric

Files:

Reply URL

Stefan Hall ●

Thank you Eric,
I'm getting somewhere with this.

That leaves the horrible renaming of “ipId” to “userId” and “userId” to “userName”, which has NOTHING to do with the user name. It is the LoginId.

;) Stefan

URL

Eric Hagfors ●

Hi Stefan,

There's the possibility of creating a task to "go back to the original names" if this is something you'd like to pursue, just let me know.

Thanks,
Eric

Reply URL

Eric Hagfors ●

Hi Stefan,

Just wanted to check in to see if you had a chance to review my reply at this time.

Thanks,

Eric

Reply URL