PLUGINAPI-180 New API for issue resolution

[ericg138]

For SonarSourcers:

Check before making the PR ready for review

• Create a JIRA ticket if the API is impacted
• Prefix the commit message with the ticket number
• Document the change in CHANGELOG.md
• When adding a new API:
  • Explain in the JavaDoc the purpose of the new API
  • Add a @since X.Y in the JavaDoc
• When deprecating an API:
  • Annotate the deprecated element with @Deprecated
  • Add a @deprecated since X.Y in the JavaDoc
  • Document the replacement in the JavaDoc (if any)
• When dropping an API:
  • Make sure it respects the deprecation policy
  • Bump the major version (breaking change)
• Make sure the tests adhere to the convention:
  • All test method names should use snake_case, for example: test_validate_input. It can also start with the methodName
• Make sure checks are green: build passes, Quality Gate is green
• Merge after getting approval by at least one member of the guild
  • If no review is made within 3 days, gently ping the reviewers
  • The guild member reviewing the code can explicitly request someone else (typically another guild member representing another team) to check the impact on the specific product
  • In some cases, the guild may deem it necessary that multiple or even all members approve a PR. This is more likely in complex changes or changes directly impacting all teams using the API.

[hashicorp-vault-sonar-prod]

PLUGINAPI-180

[henryju]

Minor comment, else LGTM

[sonarqube-next]

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0 Dependency risks
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

[ericg138]

Hi @damien-urruty-sonarsource, just letting you know about this new API, it's probably something that will need to be implemented at some point in SQ for IDE.
Feel free to comment if you have any suggestions.

[damien-urruty-sonarsource]

Thanks for the ping @ericg138. I will bring the topic to the squad, it's the first time I hear about that

[damien-urruty-sonarsource]

@ericg138 I created https://sonarsource.atlassian.net/browse/SLCORE-2079.

As a first action we will keep the existing behavior and simply ignore those issues. PMs and UX will discuss a possible follow-up. Thanks!