Skip to content

feat: Update Endpoint Description in Settings#276

Merged
acke merged 3 commits intomainfrom
fix/IDE-1054_update-endpoint-description
Mar 21, 2025
Merged

feat: Update Endpoint Description in Settings#276
acke merged 3 commits intomainfrom
fix/IDE-1054_update-endpoint-description

Conversation

@acke
Copy link
Copy Markdown
Contributor

@acke acke commented Mar 18, 2025

Description

In IDEs, you can configure a custom endpoint in order to target a custom region (e.g EU). The current description for this option is "Sets API endpoint to use for Snyk requests. Useful for custom Snyk setups. E.g. https://api.eu.snyk.io/.". With the recent platform changes, on OAuth using SSO, we automatically redirect to the right instance and that field does not need to be configured anymore.

Update
If you're using SSO (OAuth2), API endpoint configuration is automatic. Otherwise, for public regional instances, see the docs. For private instances, contact your team or account manager.

Checklist

  • Tests added and all succeed
  • Linted
  • CHANGELOG.md updated
  • README.md updated, if user-facing

Screenshots / GIFs

Visuals that may help the reviewer. Please add screenshots for any UI change. GIFs are most welcome!

@acke acke marked this pull request as ready for review March 18, 2025 13:37
@acke acke requested a review from a team as a code owner March 18, 2025 13:37
Comment thread plugin/src/main/java/io/snyk/eclipse/plugin/preferences/PreferencesPage.java Outdated
addField(tokenField);

addField(new StringFieldEditor(Preferences.PATH_KEY, "Path:", 80, getFieldEditorParent()));
addField(new LabelFieldEditor("If you're using SSO with Snyk and OAuth2 the custom endpoint configuration is automatically populated.\n"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there should be a comma after OAuth2

@acke acke merged commit 930f0cb into main Mar 21, 2025
8 checks passed
@acke acke deleted the fix/IDE-1054_update-endpoint-description branch March 21, 2025 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants