What's new in the Snyk docs?

The most recent updates include significant changes to the user docs, such as features added or removed, structure changes that affect how you find relevant information, and other improvements aimed at enhancing your interaction with the Snyk knowledge base.

October 2024

Snyk API

• Links to APIs have been updated throughout the Snyk User Docs site.

• The API pages have been extensively updated to reflect changes in how APIs are published.

• The API Authentication pages have been updated to include when to use a personal token and when to use a service account, and to improve the flow of information.

Snyk AppRisk

• Risk factors on assets is now in EA for Snyk AppRisk Pro customers.

• Asset inventory components has been updated to include details on clusters.

• Snyk Broker - AppRisk has been updated to include SonarQube installation steps.

Snyk CLI and IDEs

• The CLI authentication page has been updated for the OAuth 2.0 protocol.

• The page Debugging the Snyk CLI has been added.

• CLI standalone executables have been updated to include Alpine Arm64.

• IDE Eclipse plugin and JetBrains plugin documentation pages have been updated.

• Authentication information have been updated for all IDEs.

Snyk Integrations

• Snowflake Data Share is now in GA.

• Snyk SCM integrations has been updated with additional notices relating to repository retrieval and permission or scope modifications after initial configuration.

• The GitHub and GitHub Enterprise permission requirements section title has been changed to Personal Access Token (PAT) scopes and repository permission requirements for SCMs to capture PAT and repository permissions for multiple SCM integrations, including the GitHub Cloud App.

• GitHub Cloud App has been added to feature support notices for Fix, Backlog, and Upgrade PRs.

• Snyk SCM integrations has been updated to include a table detailing the permissions and scopes required for the GitHub Cloud App.

Other updates

• Getting started has been updated to centralize content related to everything you need to know before using Snyk.

• The Snyk Jumpstart Services Description and Customer Prerequisites have been updated for AppRisk Pro.

• Scanning methods have been added for the Dart and Flutter languages.

September 2024

Snyk API

• Most links to APIs have been updated on the docs site.

• Additional entries were made on the API docs index page.

• Regional URLs for APIs were updated.

Snyk AppRisk

• A prerequisites section has been added to the Group level of GitHub integration, and more details about the Pull personal repositories option have been added to the same documentation page.

• The Set up Insights for Snyk AppRisk section was updated to emphasize the risk factors availability for each integration option.

• The Snyk Runtime Sensor has been updated to reflect the importance of adopting it to achieve the most effective integration and to access its continuously expanded set of features.

Snyk Broker

The Universal Broker feature is now available in Early Access. The Universal Broker separates deployment and container concerns from connection concerns. It allows for a smaller or a single deployment to support numerous connections of varied types.

Snyk CLI

• The CLI commands and options summary was updated.

• Authentication has been updated.

• Configuration has been updated: Environment variables for Snyk CLI, snyk config help, snyk config environment help.

Snyk Integrations

The Snowflake Data Share section has been updated to include a Data Share Dictionary, designed to help you navigate and build your dataset.

Other updates

• The updated Regional hosting and data residency page was published.

• Glossary terms were updated for SCA, SAST, DAST, and IAST as well as Software Composition Analysis.

• Early Access release status notices were updated.

August 2024

Snyk API

• Links in the API reference docs have been updated.

• The API endpoints index and notes have been updated.

Snyk AppRisk

• The Manage Risk > Analytics pages have been consolidated to better reflect the two Snyk offerings:

  • Issues Analytics - now in Early Access for Snyk Enterprise customers.

  • Application Analytics - available only for Snyk AppRisk Pro customers.

• The Manage Assets documentation has been updated to reflect the addition of Quick filters. Users are only shown quick filters relevant to their entitlement: AppRisk Essentials or AppRisk Pro.

Snyk CLI

• snyk auth command help updated to reflect OAuth default.

• CLI authentication instructions updated for OAuth default and improved flow.

• snyk config environment command help has been added.

• CLI support for pnpm added.

Snyk IDE

• CLI authentication instructions updated for IDE.

• IDE authentication instructions updated: Eclipse, Jetbrains, VS extension, VS Code extension

Snyk Integrations

• Git repository cloning has been renamed Workspaces for SCM integrations to better reflect its functionality. Additional detail on enablement has been added.

• The relationship between GitHub organizations and Snyk Organizations when integrating with the GitHub Cloud App has been clarified.

• The deployment stages table for implementing SCM integrations has been updated to reflect AppRisk functionality.

July 2024

Snyk API

• The API documentation now provides the API Reference and explanatory documentation in the API section.

• The API End of Life (EOL) process and migration guides are now published and updated to support the process, which began in July.

Snyk AppRisk

• Asset inventory filtering describes the new, simplified view that provides an improved experience of filtering the assets.

• The Asset inventory layouts have been renamed to better reflect their functionality.

• Four new SCM integrations are now available for Snyk AppRisk:

  • Atlassian Compass

  • Harness

  • OpsLevel

  • Datadog Service Catalog

• The Snyk AppRisk documentation section has been reorganized to enhance visibility and simplify the adoption of Snyk AppRisk. Here is where you can find the main features:

  • Inventory - Manage assets section

  • Issues - Prioritize issues for fixing section

  • Policies - Assets policies section

  • Integrations - Snyk SCM integrations and Integrate with Snyk sections

  • Snyk AppRisk - Scan with Snyk section

  • Analytics - Manage risk section

Snyk Integrations

• A comparison of the GitHub and GitHub Enterprise integrations functions now resides on the SCM, IDE, and CI/CD integrations page.

• Steps for migrating from the GitHub integration to the GitHub Enterprise integration now reside on the GitHub integration page.

• The Snyk SCM Integrations page now contains information critical to using these integrations successfully in your SDLC. This includes:

  • Organizing integrations by Group and Organization level in line with Snyk AppRisk functionality

  • Git repository cloning details

  • Deployment recommendations for Enterprise customers

  • User permissions and access scope requirements for each SCM integration

  • Instructions on how to generate integrated SCM tokens for Snyk Broker

Other updates

• Snyk Reports: The issue column dictionary includes new filters and columns for Jira (JIRA ISSUES LIST, LATEST JIRA ISSUE) and EPSS (EPSS SCORE, EPSS PERCENTILE). This allows you to manage your work with Jira and to include EPSS in your prioritization steps.

• Snyk Security: Snyk has improved the prioritization workflow and risk assessment by adopting CVSS V4.0 as the default evaluation for new vulnerabilities.

• Fix code vulnerabilities automatically: DeepCode AI Fix is now available in AWS Environments and JetBrains IDEs. If you use AWS multi-tenant environments, turn on the Snyk Preview Snyk Code Fix Suggestions and retest with Snyk in your IDE.