Suggest an Idea

[simonaubert]

Hello,

 I was reading the QRS API Documentation, which is great. You can found it here :

https://help.qlik.com/en-US/sense-developer/February2021/APIs/RepositoryServiceAPI/index.html?page=0

However, on several pages, you found that :

In my understanding, either it's locked either it's deprecated but being both is, to say the less, contradictory.  I call that the Schrödinger API ^^ Could you please clarify ?

some pages impacted :
https://help.qlik.com/en-US/sense-developer/February2021/APIs/RepositoryServiceAPI/index.html?page=1...

https://help.qlik.com/en-US/sense-developer/February2021/APIs/RepositoryServiceAPI/index.html?page=2...

https://help.qlik.com/en-US/sense-developer/February2021/APIs/RepositoryServiceAPI/index.html?page=4...

Best regards,

Simon

[Jeffrey_Goldberg]

Hi there,

So something locked can also be deprecated. The deprecation period for locked APIs is 12 months from the announcement of deprecation.

https://qlik.dev/basics/api-governance

In general, we have to do a better job of announcing API deprecations and I'm working with purpose to make it work better.

Thank you for the heads up. I'll open doc bugs if they are past 12 months because you are right, at this point we can take the "locked" off.

[simonaubert]

Hello @Jeffrey_Goldberg 

Thanks for the clarification. Another point : can you give for each "to be deprecated" API the replacement on the same page ? This would help a lot.

". A replacement must be announced at the same time as the deprecation period starts unless the API is to be sunset."

There is a huge value hidden in API, we begin to exploit it to enforce some business or technical logic. 🙂

Best regards,

Simon

[Jeffrey_Goldberg]

@simonaubert ,

I concur there is tremendous value in our APIs, and I also concur that the must for a replacement is worth revisiting. Sometimes we deprecate functionality without replacement, however, if there is a replacement, it should be listed on the page.

I shall take this item and see what we can do.

thanks,

jeff g