Skip to content

Commit

Permalink
SLCORE-818 update api change doc for the AssistCreatingConnectionPara…
Browse files Browse the repository at this point in the history
…ms change
  • Loading branch information
serhat-yenican-sonarsource committed May 29, 2024
1 parent b889c5d commit 1c831ee
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions API_CHANGES.md
Original file line number Diff line number Diff line change
@@ -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<AssistSonarQubeConnection, AssistSonarCloudConnection>`
* 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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 1c831ee

Please sign in to comment.