Enhancement: Add mitigation to deprecation logs where available

SonarQube Server / Community Build
, ,
1

oh, hai :waving_hand:

//preposition: consider using the latest sonarqube server software in a container

I just started taking notes of the deprecation-logs and after finding out, that there are actually deprecated api-calls happening … i would like to propse an enhancement:

If possible, provide the “mitigation” after displaying the deprecated api-call … so for example in my case:

Now:

/api/user_groups/create Web service is deprecated since 10.4 and will be removed in a future version.

Suggestion for “Enhanced Version”:

/api/user_groups/create Web service is deprecated since 10.4 and will be removed in a future version. Consider using /api/xy/z instead

And now - while crafting this post - i cannot find a replacement for /api/user_groups/create.

And now i fear you asking me why i want to programattically create the Groups :scream:

There are many interesting and complex things mentioned in the above linked resource … so will there be a replacement for create_groups?

  • If so, it would reduce my workload if this replacement would be hinted at in the deprecation-logs :innocent:
  • If not, ehm, err, do i need to - in the future, past deprecation - manually enter the groups in the UI? :unamused_face:

I hope this braindump was concise enough to be comprehensible :sweat_smile:

cheers
Daniel

2

Hey Daniel.

I think the logs are meant to be pretty light, and if you need more info head to the changelog for the API in the UI docs.

image
image1651Ă—503 66.7 KB

1 Like
3

oh nice, you found a way to document replacements :+1:

i just did not find the info there on my own. i did look at the deprecated api-doc before i posted … i just did not think of opening this changelog sub-tab (whose content is not shown at page-load)

thats why i presumed there is none.

maybe some general hint to the location of this helpful replacement info could be placed near the “start of the journey”?

either in the docs for “Deprecation policy” or in the deprecation logs page (not IN the logs) smth like “consider looking into the deprecated web_api-docs changelog for a possible remedy/replacement”? :person_shrugging:

just my two cents, thanks to your reply myself now knows where to look :sweat_smile: :+1:

//edit: now i just press my thumbs that there isn’t a pointer already in the docs :blush:

1 Like
4

Feedback is a gift. I’ll pass it on.