Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add "/rest" to snyk api url automatically #74

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

paulrosca-snyk
Copy link
Contributor

Currently parlay expects users to provide the Snyk API URL with the /rest suffix.

This change ensures that the snyk clients add this suffix automatically.

@paulrosca-snyk paulrosca-snyk requested review from garethr and a team as code owners August 22, 2024 11:59
@mcombuechen
Copy link
Collaborator

change looks good, but can we craft a better commit message, since this will make it into the release details:

  • probably a breaking change, since consumers will have to adjust their SNYK_API environment variables
  • IMHO this is not a feat, but rather a fix to get better interop with the Snyk CLI
  • Since it's breaking, let's please provide a description on the commit body on how to fix an example setup

BREAKING CHANGE: The SNYK_API environment variable should be set to the same
value as intended for the Snyk CLI and no longer requires the "/rest" suffix.
Instead, only the base URL of the Snyk API shall be used.

To adapt to the new version, change the SNYK_API environment variable to omit
the "/rest", e.g. `SNYK_API="https://api.snyk.io"`.
@mcombuechen mcombuechen merged commit c51c0c9 into main Oct 24, 2024
8 checks passed
@mcombuechen mcombuechen deleted the feat/snyk-env-var-default branch October 24, 2024 13:05
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