From 1c831ee82371f26e1a503429066a30d9057a3d5c Mon Sep 17 00:00:00 2001 From: Serhat Yenican Date: Wed, 29 May 2024 16:17:00 +0200 Subject: [PATCH] SLCORE-818 update api change doc for the AssistCreatingConnectionParams change --- API_CHANGES.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/API_CHANGES.md b/API_CHANGES.md index fec2c7f101..a3825ef7be 100644 --- a/API_CHANGES.md +++ b/API_CHANGES.md @@ -1,3 +1,21 @@ +# 10.3 + +* `org.sonarsource.sonarlint.core.rpc.client.SonarLintRpcClientDelegate#didDetectSecret` had no `configScopeId` parameter, it was added + +## New features + +### Opening Issue in IDE + +* Add the `getConnection` method to `org.sonarsource.sonarlint.core.rpc.protocol.client.connection.AssistCreatingConnectionParams` + * It allows clients to get parameters to create either SonarQube or SonarCloud connection + * This filed type is `Either` + * Common methods of both connection types are added to the `AssistCreatingConnectionParams` class to provide users simplicity + +## Deprecation + +* `org.sonarsource.sonarlint.core.rpc.protocol.client.connection.AssistCreatingConnectionParams.getServerUrl` is only meaningful for SQ + connections. Use `getConnection().getLeft().getServerUrl()` instead to get the `serverUrl` of a SQ connection + # 10.2 ## Breaking changes @@ -28,10 +46,7 @@ * Add `getRawIssues` method to `org.sonarsource.sonarlint.core.rpc.protocol.backend.analysis.AnalyzeFilesResponse` * It allows clients to get raised issues in the analysis response. - * This method is temporarily added and will be removed when the deprecated APIs have been drop - -* Add `getOrganizationKey` method to `org.sonarsource.sonarlint.core.rpc.protocol.client.connection.AssistCreatingConnectionParams` - * It allows clients to get organizationKey parameter required for creating a Sonar Cloud connection + * This method is temporarily added and will be removed when the deprecated APIs have been dropped. ## Deprecation