@snyk/error-catalog-nodejs-public 5.32.2 → 5.34.0

package/src/catalogs/OpenSourceEcosystems-error-catalog.js

@@ -26,6 +26,7 @@ const problem_error_1 = require("../problem-error");
  * @summary Unable to parse manifest file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -37,6 +38,7 @@ class UnparseableManifestError extends problem_error_1.ProblemError {
             title: 'Unable to parse manifest file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0001',
             status: 400,
+            description: `The provided manifest file could not be parsed as it has invalid syntax or does not match the expected schema. Review the manifest file, then try again.`,
             errorCode: 'SNYK-OS-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -53,6 +55,7 @@ exports.UnparseableManifestError = UnparseableManifestError;
  * @summary Unable to parse lock file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -64,6 +67,7 @@ class UnparseableLockFileError extends problem_error_1.ProblemError {
             title: 'Unable to parse lock file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0002',
             status: 400,
+            description: `The provided lock file could not be parsed as it has invalid syntax or does not match the expected schema. Review the lock file, then try again.`,
             errorCode: 'SNYK-OS-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -83,6 +87,7 @@ exports.UnparseableLockFileError = UnparseableLockFileError;
  * @summary Unknown dependency version
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -94,6 +99,7 @@ class UnknownDependencyVersionError extends problem_error_1.ProblemError {
             title: 'Unknown dependency version',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0003',
             status: 404,
+            description: `Dependency version could not be resolved.`,
             errorCode: 'SNYK-OS-0003',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -112,6 +118,7 @@ exports.UnknownDependencyVersionError = UnknownDependencyVersionError;
  * @summary Missing required request header
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -123,6 +130,7 @@ class MissingHeaderError extends problem_error_1.ProblemError {
             title: 'Missing required request header',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0004',
             status: 422,
+            description: `The server encountered a request that is missing a mandatory request header.`,
             errorCode: 'SNYK-OS-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -139,6 +147,7 @@ exports.MissingHeaderError = MissingHeaderError;
  * @summary Payload missing required elements
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -150,6 +159,7 @@ class MissingPayloadError extends problem_error_1.ProblemError {
             title: 'Payload missing required elements',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0005',
             status: 422,
+            description: `The server could not process the request.`,
             errorCode: 'SNYK-OS-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -166,6 +176,7 @@ exports.MissingPayloadError = MissingPayloadError;
  * @summary Files cannot be processed
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -177,6 +188,7 @@ class UnprocessableFileError extends problem_error_1.ProblemError {
             title: 'Files cannot be processed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0006',
             status: 422,
+            description: `The dependency service could not process the files.`,
             errorCode: 'SNYK-OS-0006',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -193,6 +205,7 @@ exports.UnprocessableFileError = UnprocessableFileError;
  * @summary Cannot get file from source
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -204,6 +217,7 @@ class CannotGetFileFromSourceError extends problem_error_1.ProblemError {
             title: 'Cannot get file from source',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0007',
             status: 500,
+            description: `Could not get the file from the source URL.`,
             errorCode: 'SNYK-OS-0007',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -220,6 +234,7 @@ exports.CannotGetFileFromSourceError = CannotGetFileFromSourceError;
  * @summary Missing environment variable
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -231,6 +246,7 @@ class MissingEnvironmentVariableError extends problem_error_1.ProblemError {
             title: 'Missing environment variable',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0008',
             status: 500,
+            description: `The server encountered a critical operation that requires a specific environment variable, but the variable is not set or is not accessible within the current environment.`,
             errorCode: 'SNYK-OS-0008',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -247,6 +263,7 @@ exports.MissingEnvironmentVariableError = MissingEnvironmentVariableError;
  * @summary Brokered connections not currently supported
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -258,6 +275,7 @@ class BrokeredConnectionNotSupportedError extends problem_error_1.ProblemError {
             title: 'Brokered connections not currently supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0009',
             status: 500,
+            description: `The service encountered a permissions or credentials error most likely related to an import through a brokered connection for a scanner that does not yet support that.`,
             errorCode: 'SNYK-OS-0009',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -280,6 +298,7 @@ exports.BrokeredConnectionNotSupportedError = BrokeredConnectionNotSupportedErro
  * @summary Snyk failed to clone your repository
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -291,6 +310,13 @@ class GitCloneFailedError extends problem_error_1.ProblemError {
             title: 'Snyk failed to clone your repository',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-0010',
             status: 422,
+            description: `We encountered a fatal error from Git while trying to clone your code using your provided credentials. Please verify that:
+
+* Your provided credentials are correct or not scoped too narrowly.
+* The branch you've asked us to clone exists.
+* The repository you've provided is accessible from the internet and you are not connected through a broker.
+
+And try the operation again.`,
             errorCode: 'SNYK-OS-0010',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -310,6 +336,7 @@ exports.GitCloneFailedError = GitCloneFailedError;
  * @summary Unsupported manifest file type for remediation
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -321,6 +348,7 @@ class UnsupportedManifestFileError extends problem_error_1.ProblemError {
             title: 'Unsupported manifest file type for remediation',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0001',
             status: 400,
+            description: `The provided manifest file is not supported by Snyk for .NET.`,
             errorCode: 'SNYK-OS-DOTNET-0001',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -339,6 +367,7 @@ exports.UnsupportedManifestFileError = UnsupportedManifestFileError;
  * @summary Target framework not supported
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -350,6 +379,7 @@ class UnsupportedTargetFrameworkError extends problem_error_1.ProblemError {
             title: 'Target framework not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0002',
             status: 422,
+            description: `The provided manifest file defines a \`<TargetFramework>\` or \`<TargetFrameworks>\` that is not currently supported by Snyk's .NET scanning solution.`,
             errorCode: 'SNYK-OS-DOTNET-0002',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -384,6 +414,7 @@ exports.UnsupportedTargetFrameworkError = UnsupportedTargetFrameworkError;
  * @summary Your C# code is missing a static Main function
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -395,6 +426,22 @@ class MissingStaticMainFunctionError extends problem_error_1.ProblemError {
             title: 'Your C# code is missing a static Main function',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0003',
             status: 422,
+            description: `This error occurs when no static Main method with a correct signature is found in the code that produces an executable file. 
+It also occurs if the entry point function, \`Main\`, is defined with the wrong case, such as lower-case main.
+
+In order to fix this issue, ensure that your program has a .cs file that contains a main function, such as
+\`\`\`c#
+namespace Example
+{
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            Console.WriteLine("hello world");
+        }
+    }
+}
+\`\`\``,
             errorCode: 'SNYK-OS-DOTNET-0003',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -426,6 +473,7 @@ exports.MissingStaticMainFunctionError = MissingStaticMainFunctionError;
  * @summary The dotnet CLI is unable to generate a self-contained binary
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -437,6 +485,15 @@ class PublishFailedError extends problem_error_1.ProblemError {
             title: 'The dotnet CLI is unable to generate a self-contained binary',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0004',
             status: 422,
+            description: `This error occurs when running \`dotnet publish --sc --framework <your-target-framework>\` fails to generate a 
+self-contained binary. Snyk needs to run this command in order to adequately determine the dependency tree for your project. If this command fails, Snyk cannot continue.
+
+Steps to determine why this happened:
+
+* Checkout a clean version of your project in a temporary folder
+* Run \`dotnet publish --sc --framework <your-target-framework> \` on your project, and confirm this step fails.
+
+If this step is successful locally, it is possible that Snyk is running another version of the .NET SDK. To tell Snyk which version of the .NET SDK to use, consider using the [global.json](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) solution provided by Microsoft.`,
             errorCode: 'SNYK-OS-DOTNET-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -477,6 +534,7 @@ exports.PublishFailedError = PublishFailedError;
  * @summary The dotnet CLI was unable to restore from private package sources
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -488,6 +546,24 @@ class FailedToAccessPrivatePackageSourceError extends problem_error_1.ProblemErr
             title: 'The dotnet CLI was unable to restore from private package sources',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0005',
             status: 401,
+            description: `This error occurs when running \`dotnet restore\` fails to access dependencies stored in a private package source that Snyk does not have access to. 
+
+This means that your \`.csproj\` file or files refer to a dependency hosted on a private package store or Nuget Artifact Registry defined in your \`NuGet.config\` file, such as:
+
+\`\`\`xml
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="AzureFeed" value="https://pkgs.dev.azure.com/your-org/_packaging/your-repo/nuget/v3/index.json" />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>
+\`\`\`
+
+In order to allow Snyk to access your private dependency package source, you must supply Snyk with a valid JSON object as a private registry token in the .NET language settings.
+
+You can set up a connection to your private Nuget repository in your Snyk integration settings.`,
             errorCode: 'SNYK-OS-DOTNET-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -546,6 +622,7 @@ exports.FailedToAccessPrivatePackageSourceError = FailedToAccessPrivatePackageSo
  * @summary Missing MSBuild Condition Construct in project file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -557,6 +634,44 @@ class MissingMSBuildConditionError extends problem_error_1.ProblemError {
             title: 'Missing MSBuild Condition Construct in project file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0006',
             status: 422,
+            description: `The \`dotnet\` tool was unable to locate the \`.targets\`, \`.csproj\` or \`.props\` file responsible for one or more MSBuild conditions in your project file.
+
+The tool encountered an error like 
+\`\`\`
+/path/to/file/project.csproj(33,13): error MSB4100: Expected "$(SomeCondition)" to evaluate to a boolean instead of "", in condition "!$(SomeCondition)".
+\`\`\`
+
+This means the condition definition is missing in the project file that is currently being restored and in any project linked to it from there.      
+
+Snyk can scan only the project files accessible in the current repository or the private dependencies available to Snyk.
+
+For example, if your code has the following structure:
+
+\`\`\`title=project.targets
+<Project>
+  <PropertyGroup>
+    <SomeCondition Condition="'$(SomeCondition)' == ''">false</SomeCondition>
+  </PropertyGroup>
+</Project>
+\`\`\`
+
+And
+
+\`\`\`title=project.csproj
+<Project Sdk='Microsoft.NET.Sdk'>
+  <Import Project='..\\external-libraries\\some-library\\project.targets' />
+  <PropertyGroup>
+    <TargetFrameworks>net8.0</TargetFrameworks>
+  </PropertyGroup>
+  <ItemGroup Condition='!$(SomeCondition)'>
+    <PackageReference Include='Newtonsoft.Json' Version='13.0.3' />
+  </ItemGroup>
+</Project>
+\`\`\`
+
+And \`external-libraries\` is not a part of your repository currently being scanned, Snyk is not able to find it.
+
+This error occurs when your code depends on external libraries that are added to or generated from your source code using external tools unknown to Snyk or as part of a build step in your build or a deployment pipeline.`,
             errorCode: 'SNYK-OS-DOTNET-0006',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -580,6 +695,7 @@ exports.MissingMSBuildConditionError = MissingMSBuildConditionError;
  * @summary No target frameworks found in manifest files
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -591,6 +707,9 @@ class NoTargetFrameworksFoundError extends problem_error_1.ProblemError {
             title: 'No target frameworks found in manifest files',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0007',
             status: 422,
+            description: `Snyk was unable to detect any \`<TargetFramework>\`s in the supplied manifest files. 
+
+If you are using \`Directory.Build.props\` files to determine the target framework, ensure that it is named as such. Due to performance considerations on the customer's SCM network, Snyk does not perform case-insensitive searches for \`.props\` files.`,
             errorCode: 'SNYK-OS-DOTNET-0007',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -671,6 +790,7 @@ exports.NoTargetFrameworksFoundError = NoTargetFrameworksFoundError;
  * @summary Your global.json is targeting an outdated SDK version
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -682,6 +802,64 @@ class OutdatedSDKVersionRequestedError extends problem_error_1.ProblemError {
             title: 'Your global.json is targeting an outdated SDK version',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0008',
             status: 422,
+            description: `Snyk supports the latest channels of .NET which is currently [supported by Microsoft](https://dotnet.microsoft.com/en-us/download/dotnet), but does **not** guarantee to support all SDK versions within each currently supported channel.
+
+Within the supported channels, Snyk aims to support most, if not all, of the SDK versions currently released under the **newest** of the channels.
+
+If the channels currently supported by Microsoft are \`8.0\`, \`7.0\` and \`6.0\`, Snyk **will** support all of the *latest* SDKs released for these channels.
+
+If the SDK versions released under \`8.0.3\` are: \`8.0.203\`, \`8.0.202\` and \`8.0.103\`, Snyk **cannot** guarantee to support *all* of them, but makes an effort to do so. Snyk **will** support the latest of the SDK versions currently released by Microsoft. 
+
+If channel \`8.0\` is the newest channel currently supported, Snyk **cannot** guarantee that multiple, specific SDK versions for older, still supported channels such as .NET 6. 
+
+### Example support matrix
+
+If:
+
+* .NET channels currently supported by Microsoft are \`.NET 8.0\`,  \`.NET 7.0\` and  \`.NET 6.0\`
+* Newest SDK version under \`.NET 8.0\` is \`8.0.203\`
+
+Then:
+
+| Channel |              SDK             | End-of-Life |  Supported  |
+|:-------:|:----------------------------:|:-----------:|:-----------:|
+|   8.0   | 8.0.203  (latest in channel) |      No     |     Yes     |
+|   8.0   |            8.0.202           |      No     |     Yes     |
+|   8.0   |            8.0.103           |      No     |     Yes     |
+|         |             (...)            |             |             |
+|   7.0   | 7.0.407  (latest in channel) |      No     |     Yes     |
+|   7.0   |            7.0.314           |      No     |      No     |
+|         |             (...)            |             |             |
+|   6.0   |            6.0.420           |      No     |     Yes     |
+|   6.0   |            6.0.128           |      No     |      No     |
+|         |             (..)             |             |             |
+|   5.0   |  5.0.408 (latest in channel) |     Yes     |      No     |
+|   5.0   |            5.0.214           |     Yes     |      No     |
+|         |             (..)             |             |             |
+
+### Workarounds
+
+This limitation can lead to scan failures for customers that are pinning SDK versions in their \`global.json\` files without a [rollForward](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#rollforward) directive, such as:
+\`\`\`json
+{
+  "sdk": {
+    "version": "6.0.101"
+  }
+}
+\`\`\`
+Since as \`6.0\` is not the newest .NET channel. 
+
+To work around this issue, we recommend that customers employ some flexibility in their \`global.json\` file by employing the \`rollFoward\` directive to be \`latestMajor\`, as such:
+\`\`\`json
+{
+  "sdk": {
+    "version": "6.0.101",
+    "rollForward": "latestMajor"
+  }
+}
+\`\`\`
+
+Which will allow Snyk to scan your code using a newer version of the SDK, despite your version pinning.`,
             errorCode: 'SNYK-OS-DOTNET-0008',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -709,6 +887,7 @@ exports.OutdatedSDKVersionRequestedError = OutdatedSDKVersionRequestedError;
  * @summary Project failed to build due to missing type or namespace references
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -720,6 +899,11 @@ class ProjectSkippedAndNotFoundError extends problem_error_1.ProblemError {
             title: 'Project failed to build due to missing type or namespace references',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-dotnet-0009',
             status: 422,
+            description: `While attempting to build your solution for scanning, the \`dotnet\` SDK was unable to restore one or more projects referenced in your manifest files.
+
+Please note that Snyk runs these builds on a **case-sensitive** filesystem, meaning that \`<ProjectReference>../src/NS.Project.csproj</ProjectReference>\` and \`<ProjectReference>../src/ns.project.csproj</ProjectReference>\` are not referring to the same thing.
+
+This can present itself as a problem for customers that are using Mac or Windows build pipeline where file systems are not case-sensitive. In this case, verify you're referring to the right manifest files and check the Snyk import logs for more details.`,
             errorCode: 'SNYK-OS-DOTNET-0009',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -741,6 +925,7 @@ exports.ProjectSkippedAndNotFoundError = ProjectSkippedAndNotFoundError;
  * @summary Failed to access private module
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -752,6 +937,7 @@ class PrivateModuleError extends problem_error_1.ProblemError {
             title: 'Failed to access private module',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0001',
             status: 400,
+            description: `Snyk could not access the private modules within your go.mod files.`,
             errorCode: 'SNYK-OS-GO-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -773,6 +959,7 @@ exports.PrivateModuleError = PrivateModuleError;
  * @summary Go mod file not found
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -784,6 +971,7 @@ class GoModFileMissingError extends problem_error_1.ProblemError {
             title: 'Go mod file not found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0002',
             status: 400,
+            description: `A go.mod file was not found in the current directory or any parent directory.`,
             errorCode: 'SNYK-OS-GO-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -810,6 +998,7 @@ exports.GoModFileMissingError = GoModFileMissingError;
  * @summary OAuth re-authorization required
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -822,6 +1011,12 @@ class SsoReAuthRequiredError extends problem_error_1.ProblemError {
             title: 'OAuth re-authorization required',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0003',
             status: 422,
+            description: `Your code is cloned on an isolated environment using Git as it is required by Snyk to analyze its dependencies.
+
+Your Organization has enabled or enforced SAML SSO after you authorized Snyk to access your code, and a re-authentication is therefore required.
+
+The error you're seeing is usually reproducible by attempting to do a \`git clone\` of your repository with incorrectly configured credentials.
+Verify your authentication configuration with your Git cloud provider and try again.`,
             errorCode: 'SNYK-OS-GO-0003',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -851,6 +1046,7 @@ exports.SsoReAuthRequiredError = SsoReAuthRequiredError;
  * @summary Your project repository is missing required files
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -862,6 +1058,13 @@ class IncompleteProjectError extends problem_error_1.ProblemError {
             title: 'Your project repository is missing required files',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0004',
             status: 422,
+            description: `Generating the dependency graph requires Snyk to run go list \`go list -deps -json\` inside the project. If the operation fails, creating a full dependency graph cannot continue.  
+
+This error means that you need some cleanup, (such as \`go mod tidy\`) or your project deployment process contains a code generation step such as \`protobuf\` or similar that is not currently supported by Snyk. 
+
+To verify if this is the case, clone your project in a clean environment, run go list \`go list -deps -json\` and verify whether the operation fails. 
+
+If Snyk cannot process your code successfully, insert the Snyk CLI as part of your deployment pipeline.`,
             errorCode: 'SNYK-OS-GO-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -895,6 +1098,7 @@ exports.IncompleteProjectError = IncompleteProjectError;
  * @summary Your project repository has inconsistent vendoring information
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -906,6 +1110,17 @@ class InconsistentVendoringError extends problem_error_1.ProblemError {
             title: 'Your project repository has inconsistent vendoring information',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0005',
             status: 422,
+            description: `Generating the dependency graph requires Snyk to run \`go list -deps -json\` inside the project. If the operation fails, creating a full dependency graph cannot continue.  
+
+This error means that there is inconsistency between your \`vendor/modules.txt\` file and your \`go.mod\` file. To remediate, you need to:
+
+* \`go mod vendor\`
+* \`go mod tidy\`
+
+Next, commit those changes to your repo. Snyk does not manipulate with your code on our end by design, which is why this is not done automatically.
+
+To verify if this is the case, clone your project in a clean environment, run go list \`go list -deps -json\` and verify whether the operation fails. 
+Then try and run the above mentioned commands and see if your SCM system reports changes in files.`,
             errorCode: 'SNYK-OS-GO-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -926,6 +1141,7 @@ exports.InconsistentVendoringError = InconsistentVendoringError;
  * @summary Unsupported external file generation
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -937,6 +1153,9 @@ class UnsupportedExternalFileGenerationSCMError extends problem_error_1.ProblemE
             title: 'Unsupported external file generation',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0006',
             status: 422,
+            description: `Snyk currently does not support external file generation in your project. This limitation is due to Snyk's lack of visibility into the third-party generator tools you may be using and the specific commands required to generate these files.
+
+Snyk can only work with the files available in your repository and does not have insight into the generation process for external files.`,
             errorCode: 'SNYK-OS-GO-0006',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -961,6 +1180,7 @@ exports.UnsupportedExternalFileGenerationSCMError = UnsupportedExternalFileGener
  * @summary Unable to access private dependencies
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -972,6 +1192,12 @@ class UnableToAccessPrivateDepsError extends problem_error_1.ProblemError {
             title: 'Unable to access private dependencies',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0007',
             status: 422,
+            description: `The Go tool encountered a \`DepsError\` while trying to download a private dependency. Private repositories that are not accessible to the public internet and are not available on the official Go proxy mirror are cloned with a version control system and built on demand. 
+This requires the VCS to have the correct access rights to that repository.
+
+Snyk supports private repositories that are hosted in the same Organization and on the same Project that is scanned for vulnerabilities. The authentication to the private repository is the same as the authentication used to integrate that repository with Snyk. 
+
+This error appears when the authorization credentials do not allow access to the requested private dependency. `,
             errorCode: 'SNYK-OS-GO-0007',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -994,6 +1220,7 @@ exports.UnableToAccessPrivateDepsError = UnableToAccessPrivateDepsError;
  * @summary Unable to fetch private dependencies
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1005,6 +1232,11 @@ class UnableToUseCredentialsError extends problem_error_1.ProblemError {
             title: 'Unable to fetch private dependencies',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0008',
             status: 401,
+            description: `The Go tool encountered a permissions error while fetching one of the private dependencies. Ensure that the integration token you used to sign in to Snyk is properly configured so that Snyk can access the private dependencies.
+
+The Snyk Go integration only supports private dependencies that are used inside the same Organization as the Project you are scanning.
+
+This error appears when Snyk is unable to properly access the authorization credentials for the requested private dependency. `,
             errorCode: 'SNYK-OS-GO-0008',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1021,6 +1253,7 @@ exports.UnableToUseCredentialsError = UnableToUseCredentialsError;
  * @summary Toolchain not available
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1032,6 +1265,7 @@ class ToolchainNotAvailableError extends problem_error_1.ProblemError {
             title: 'Toolchain not available',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-go-0009',
             status: 500,
+            description: `Could not download Go toolchain.`,
             errorCode: 'SNYK-OS-GO-0009',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1048,6 +1282,7 @@ exports.ToolchainNotAvailableError = ToolchainNotAvailableError;
  * @summary Missing property
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1059,6 +1294,7 @@ class MissingRequirementFromPomError extends problem_error_1.ProblemError {
             title: 'Missing property',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0001',
             status: 422,
+            description: `The required property is missing from the pom object.`,
             errorCode: 'SNYK-OS-MAVEN-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1075,6 +1311,7 @@ exports.MissingRequirementFromPomError = MissingRequirementFromPomError;
  * @summary Unable to resolve value for property
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1086,6 +1323,7 @@ class UnableToResolveValueForPropertyError extends problem_error_1.ProblemError
             title: 'Unable to resolve value for property',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0002',
             status: 422,
+            description: `The targeted property could not be resolved with a valid value.`,
             errorCode: 'SNYK-OS-MAVEN-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1102,6 +1340,7 @@ exports.UnableToResolveValueForPropertyError = UnableToResolveValueForPropertyEr
  * @summary Unable to resolve version for property
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1113,6 +1352,7 @@ class UnableToResolveVersionForPropertyError extends problem_error_1.ProblemErro
             title: 'Unable to resolve version for property',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0003',
             status: 500,
+            description: `The targeted property could not be resolved with a valid version.`,
             errorCode: 'SNYK-OS-MAVEN-0003',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1129,6 +1369,7 @@ exports.UnableToResolveVersionForPropertyError = UnableToResolveVersionForProper
  * @summary Cyclic property detected in POM file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1140,6 +1381,7 @@ class CyclicPropertyDetectedInPomFileError extends problem_error_1.ProblemError
             title: 'Cyclic property detected in POM file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0004',
             status: 422,
+            description: `There is circular dependency among properties in the Maven project's configuration file (POM), preventing proper resolution and causing an error.`,
             errorCode: 'SNYK-OS-MAVEN-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1156,6 +1398,7 @@ exports.CyclicPropertyDetectedInPomFileError = CyclicPropertyDetectedInPomFileEr
  * @summary Error parsing the XML file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1167,6 +1410,7 @@ class UnableToParseXMLError extends problem_error_1.ProblemError {
             title: 'Error parsing the XML file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0005',
             status: 422,
+            description: `There is an error parsing the XML file. This could be referring to either pom.xml or maven-metadata.xml.`,
             errorCode: 'SNYK-OS-MAVEN-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1183,6 +1427,7 @@ exports.UnableToParseXMLError = UnableToParseXMLError;
  * @summary Invalid coordinates provided
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1194,6 +1439,7 @@ class InvalidCoordinatesError extends problem_error_1.ProblemError {
             title: 'Invalid coordinates provided',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0006',
             status: 422,
+            description: `The coordinates provided for a project were invalid.`,
             errorCode: 'SNYK-OS-MAVEN-0006',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1210,6 +1456,7 @@ exports.InvalidCoordinatesError = InvalidCoordinatesError;
  * @summary Skipping group
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1221,6 +1468,7 @@ class SkippedGroupError extends problem_error_1.ProblemError {
             title: 'Skipping group',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0007',
             status: 422,
+            description: `Skipping a specific groupId starting due to remapped coordinates.`,
             errorCode: 'SNYK-OS-MAVEN-0007',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1237,6 +1485,7 @@ exports.SkippedGroupError = SkippedGroupError;
  * @summary Pom file not found
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1248,6 +1497,7 @@ class PomFileNotFoundError extends problem_error_1.ProblemError {
             title: 'Pom file not found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0008',
             status: 422,
+            description: `The pom file was not found in Maven repository.`,
             errorCode: 'SNYK-OS-MAVEN-0008',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1264,6 +1514,7 @@ exports.PomFileNotFoundError = PomFileNotFoundError;
  * @summary Missing project from POM
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1275,6 +1526,7 @@ class MissingProjectFromPomError extends problem_error_1.ProblemError {
             title: 'Missing project from POM',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0009',
             status: 422,
+            description: `A project element is missing from POM.`,
             errorCode: 'SNYK-OS-MAVEN-0009',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1291,6 +1543,7 @@ exports.MissingProjectFromPomError = MissingProjectFromPomError;
  * @summary Cannot resolve the target POM from the input XML
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1302,6 +1555,7 @@ class CannotResolveTargetPomFromXmlError extends problem_error_1.ProblemError {
             title: 'Cannot resolve the target POM from the input XML',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0010',
             status: 422,
+            description: `Cannot resolve the targeted POM from the input XML.`,
             errorCode: 'SNYK-OS-MAVEN-0010',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1318,6 +1572,7 @@ exports.CannotResolveTargetPomFromXmlError = CannotResolveTargetPomFromXmlError;
  * @summary Cannot resolve the target POM from the repository
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1329,6 +1584,7 @@ class CannotResolveTargetPomFromRepoError extends problem_error_1.ProblemError {
             title: 'Cannot resolve the target POM from the repository',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0011',
             status: 404,
+            description: `Cannot resolve the targeted POM from the repository.`,
             errorCode: 'SNYK-OS-MAVEN-0011',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1345,6 +1601,7 @@ exports.CannotResolveTargetPomFromRepoError = CannotResolveTargetPomFromRepoErro
  * @summary Cannot get the build file repository
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1356,6 +1613,7 @@ class CannotGetBuildFileFromRepoError extends problem_error_1.ProblemError {
             title: 'Cannot get the build file repository',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0012',
             status: 404,
+            description: `Cannot get the build file repository.`,
             errorCode: 'SNYK-OS-MAVEN-0012',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1372,6 +1630,7 @@ exports.CannotGetBuildFileFromRepoError = CannotGetBuildFileFromRepoError;
  * @summary Unable to create hosted git info
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1383,6 +1642,7 @@ class CannotCreateGitHostError extends problem_error_1.ProblemError {
             title: 'Unable to create hosted git info',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0013',
             status: 500,
+            description: `Cannot create source URL.`,
             errorCode: 'SNYK-OS-MAVEN-0013',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1399,6 +1659,7 @@ exports.CannotCreateGitHostError = CannotCreateGitHostError;
  * @summary No released version for versions range
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1410,6 +1671,7 @@ class NoReleasedVersionForVersionsRangeError extends problem_error_1.ProblemErro
             title: 'No released version for versions range',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0014',
             status: 422,
+            description: `There was no version released for the specified versions range.`,
             errorCode: 'SNYK-OS-MAVEN-0014',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1426,6 +1688,7 @@ exports.NoReleasedVersionForVersionsRangeError = NoReleasedVersionForVersionsRan
  * @summary Source is not supported
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1437,6 +1700,7 @@ class SourceNotSupportedError extends problem_error_1.ProblemError {
             title: 'Source is not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0015',
             status: 422,
+            description: `The source used is not supported by fetcher. The supported sources are: github, bitbucket, gitlab.`,
             errorCode: 'SNYK-OS-MAVEN-0015',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -1453,6 +1717,7 @@ exports.SourceNotSupportedError = SourceNotSupportedError;
  * @summary Timeout when processing the dependency tree
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1464,6 +1729,7 @@ class TimeoutWhenProcessingTheDepTreeError extends problem_error_1.ProblemError
             title: 'Timeout when processing the dependency tree',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0016',
             status: 422,
+            description: `There was an timeout when processing the dependency tree.`,
             errorCode: 'SNYK-OS-MAVEN-0016',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1490,6 +1756,7 @@ exports.TimeoutWhenProcessingTheDepTreeError = TimeoutWhenProcessingTheDepTreeEr
  * @summary Cannot reach one or more Maven repositories configured under your Snyk organisations language settings
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1501,6 +1768,14 @@ class CannotReachConfiguredRepositoryError extends problem_error_1.ProblemError
             title: 'Cannot reach one or more Maven repositories configured under your Snyk organisations language settings',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-maven-0017',
             status: 404,
+            description: `One or more of the Maven repositories configured under your organisations language settings cannot be reached.
+
+This error can happen for a variety of reasons:
+
+* If using broker it could be a misconfiguration in your broker client. Double check the username and password. 
+* It could be network connectivity between the broker client and Snyk or between the broker client and the configured repository, check your firewall rules.
+
+In order to solve this issue, refer to the specific details of this error message to identify which repository is causing issues. `,
             errorCode: 'SNYK-OS-MAVEN-0017',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1519,6 +1794,7 @@ exports.CannotReachConfiguredRepositoryError = CannotReachConfiguredRepositoryEr
  * @summary No repository found for A NPM package
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1530,6 +1806,7 @@ class NoRepoFoundForTheNPMPackageError extends problem_error_1.ProblemError {
             title: 'No repository found for A NPM package',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0001',
             status: 422,
+            description: `No repository found for the NPM package.`,
             errorCode: 'SNYK-OS-NODEJS-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1546,6 +1823,7 @@ exports.NoRepoFoundForTheNPMPackageError = NoRepoFoundForTheNPMPackageError;
  * @summary Could not parse NPM registry URL
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1557,6 +1835,7 @@ class CouldNotParseNPMRegistryURLError extends problem_error_1.ProblemError {
             title: 'Could not parse NPM registry URL',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0002',
             status: 422,
+            description: `Could not parse NPM registry URL.`,
             errorCode: 'SNYK-OS-NODEJS-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1573,6 +1852,7 @@ exports.CouldNotParseNPMRegistryURLError = CouldNotParseNPMRegistryURLError;
  * @summary Could not find a broker resolved URL
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1584,6 +1864,7 @@ class CouldNotFindBrokerURLError extends problem_error_1.ProblemError {
             title: 'Could not find a broker resolved URL',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0003',
             status: 422,
+            description: `Could not find a broker resolved URL.`,
             errorCode: 'SNYK-OS-NODEJS-0003',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1600,6 +1881,7 @@ exports.CouldNotFindBrokerURLError = CouldNotFindBrokerURLError;
  * @summary Unable to replace broker URL
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1611,6 +1893,7 @@ class UnableToReplaceBrokerURLError extends problem_error_1.ProblemError {
             title: 'Unable to replace broker URL',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0004',
             status: 422,
+            description: `Unable to replace all broker urls in lock file.`,
             errorCode: 'SNYK-OS-NODEJS-0004',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1627,6 +1910,7 @@ exports.UnableToReplaceBrokerURLError = UnableToReplaceBrokerURLError;
  * @summary Bad NPM version
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1638,6 +1922,7 @@ class BadNPMVersionError extends problem_error_1.ProblemError {
             title: 'Bad NPM version',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0005',
             status: 422,
+            description: `The NPM version is not supported.`,
             errorCode: 'SNYK-OS-NODEJS-0005',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -1654,6 +1939,7 @@ exports.BadNPMVersionError = BadNPMVersionError;
  * @summary Unknown blob encoding on Github
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1665,6 +1951,7 @@ class UnknownBlobEncodingOnGithubError extends problem_error_1.ProblemError {
             title: 'Unknown blob encoding on Github',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0006',
             status: 422,
+            description: `Unknown blob encoding on Github.`,
             errorCode: 'SNYK-OS-NODEJS-0006',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1681,6 +1968,7 @@ exports.UnknownBlobEncodingOnGithubError = UnknownBlobEncodingOnGithubError;
  * @summary No result from forked process
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1692,6 +1980,7 @@ class NoResultsFromForkerProcessesError extends problem_error_1.ProblemError {
             title: 'No result from forked process',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0007',
             status: 500,
+            description: `No result from forked process.`,
             errorCode: 'SNYK-OS-NODEJS-0007',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1708,6 +1997,7 @@ exports.NoResultsFromForkerProcessesError = NoResultsFromForkerProcessesError;
  * @summary Child Process Execution Error
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1719,6 +2009,7 @@ class ChildProcessExecutionError extends problem_error_1.ProblemError {
             title: 'Child Process Execution Error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0008',
             status: 500,
+            description: `The child process encountered an error during execution.`,
             errorCode: 'SNYK-OS-NODEJS-0008',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1735,6 +2026,7 @@ exports.ChildProcessExecutionError = ChildProcessExecutionError;
  * @summary No valid package upgrades
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1746,6 +2038,7 @@ class NoValidPackageUpgradesError extends problem_error_1.ProblemError {
             title: 'No valid package upgrades',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0009',
             status: 422,
+            description: `The system attempted to find valid upgrades for the packages specified in the lock file, but none were available.`,
             errorCode: 'SNYK-OS-NODEJS-0009',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1762,6 +2055,7 @@ exports.NoValidPackageUpgradesError = NoValidPackageUpgradesError;
  * @summary No dependency updates
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1773,6 +2067,7 @@ class NoDependencyUpdatesError extends problem_error_1.ProblemError {
             title: 'No dependency updates',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0010',
             status: 422,
+            description: `There are no available updates for the dependencies.`,
             errorCode: 'SNYK-OS-NODEJS-0010',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1789,6 +2084,7 @@ exports.NoDependencyUpdatesError = NoDependencyUpdatesError;
  * @summary Could not parse JSON file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1800,6 +2096,7 @@ class CouldNotParseJSONFileError extends problem_error_1.ProblemError {
             title: 'Could not parse JSON file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0011',
             status: 422,
+            description: `An error occurred while attempting to parse a JSON file.`,
             errorCode: 'SNYK-OS-NODEJS-0011',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1816,6 +2113,7 @@ exports.CouldNotParseJSONFileError = CouldNotParseJSONFileError;
  * @summary Could not Base64 encode
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1827,6 +2125,7 @@ class Base64EncodeError extends problem_error_1.ProblemError {
             title: 'Could not Base64 encode',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0012',
             status: 422,
+            description: `An error occurred while attempting to perform Base64 encoding.`,
             errorCode: 'SNYK-OS-NODEJS-0012',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1843,6 +2142,7 @@ exports.Base64EncodeError = Base64EncodeError;
  * @summary Could not Base64 decode
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1854,6 +2154,7 @@ class Base64DecodeError extends problem_error_1.ProblemError {
             title: 'Could not Base64 decode',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0013',
             status: 422,
+            description: `An error occurred while attempting to perform Base64 decoding.`,
             errorCode: 'SNYK-OS-NODEJS-0013',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -1870,6 +2171,7 @@ exports.Base64DecodeError = Base64DecodeError;
  * @summary Missing supported file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1881,6 +2183,7 @@ class MissingSupportedFileError extends problem_error_1.ProblemError {
             title: 'Missing supported file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0014',
             status: 400,
+            description: `Could not find supported file.`,
             errorCode: 'SNYK-OS-NODEJS-0014',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1897,6 +2200,7 @@ exports.MissingSupportedFileError = MissingSupportedFileError;
  * @summary Invalid configuration
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1908,6 +2212,7 @@ class InvalidConfigurationError extends problem_error_1.ProblemError {
             title: 'Invalid configuration',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0015',
             status: 400,
+            description: `The configuration parameter does not meet the expected data type. Please ensure the provided value is of the correct data type.`,
             errorCode: 'SNYK-OS-NODEJS-0015',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -1931,6 +2236,7 @@ exports.InvalidConfigurationError = InvalidConfigurationError;
  * @summary Out of Sync Error
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1942,6 +2248,11 @@ class PnpmOutOfSyncError extends problem_error_1.ProblemError {
             title: 'Out of Sync Error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0016',
             status: 422,
+            description: `Sometimes a project may become out of sync between the lockfile and the manifest file. This might happen if the package.json is modified or updated but the pnpm-lock.yaml is not. 
+
+This can be resolved by ensuring the lockfile and manifest file are correctly synced, by executing pnpm install.
+
+In some cases, it may be necessary to delete the node_modules folder and the pnpm-lock.yaml and run pnpm install again to force a full reinstall. `,
             errorCode: 'SNYK-OS-NODEJS-0016',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -1960,6 +2271,7 @@ exports.PnpmOutOfSyncError = PnpmOutOfSyncError;
  * @summary Unsupported pnpm lockfile version
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1971,6 +2283,7 @@ class PnpmUnsupportedLockfileVersionError extends problem_error_1.ProblemError {
             title: 'Unsupported pnpm lockfile version',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0017',
             status: 422,
+            description: `The lockfile version is not supported. Supported lockfile versions for pnpm include v5 and v6.`,
             errorCode: 'SNYK-OS-NODEJS-0017',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -1987,6 +2300,7 @@ exports.PnpmUnsupportedLockfileVersionError = PnpmUnsupportedLockfileVersionErro
  * @summary Yarn package not found
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -1998,6 +2312,7 @@ class YarnPackageNotFoundError extends problem_error_1.ProblemError {
             title: 'Yarn package not found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0019',
             status: 404,
+            description: `Snyk could not find the package in the Yarn registry.`,
             errorCode: 'SNYK-OS-NODEJS-0019',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2014,6 +2329,7 @@ exports.YarnPackageNotFoundError = YarnPackageNotFoundError;
  * @summary Unable to reach package registry
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2025,6 +2341,7 @@ class UnableToReachRegistryError extends problem_error_1.ProblemError {
             title: 'Unable to reach package registry',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0020',
             status: 503,
+            description: `Snyk could not reach the node package registry.`,
             errorCode: 'SNYK-OS-NODEJS-0020',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2041,6 +2358,7 @@ exports.UnableToReachRegistryError = UnableToReachRegistryError;
  * @summary Lock file is outdated
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2052,6 +2370,7 @@ class OutdatedYarnLockFileError extends problem_error_1.ProblemError {
             title: 'Lock file is outdated',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0021',
             status: 409,
+            description: `The lock file is outdated. Update the lock file and try again.`,
             errorCode: 'SNYK-OS-NODEJS-0021',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2068,6 +2387,7 @@ exports.OutdatedYarnLockFileError = OutdatedYarnLockFileError;
  * @summary Unable to read from remote repository
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2079,6 +2399,7 @@ class PermissionDeniedError extends problem_error_1.ProblemError {
             title: 'Unable to read from remote repository',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-nodejs-0022',
             status: 401,
+            description: `Snyk does not have sufficient permissions to access the repository, or the repository does not exist.`,
             errorCode: 'SNYK-OS-NODEJS-0022',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2098,6 +2419,7 @@ exports.PermissionDeniedError = PermissionDeniedError;
  * @summary Unsupported manifest file type for remediation
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2109,6 +2431,7 @@ class UnsupportedRequirementsFileError extends problem_error_1.ProblemError {
             title: 'Unsupported manifest file type for remediation',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0001',
             status: 422,
+            description: `The provided requirements file is not supported by Snyk for Python.`,
             errorCode: 'SNYK-OS-PYTHON-0001',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -2127,6 +2450,7 @@ exports.UnsupportedRequirementsFileError = UnsupportedRequirementsFileError;
  * @summary Received more manifests than expected
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2138,6 +2462,7 @@ class TooManyManifestFilesError extends problem_error_1.ProblemError {
             title: 'Received more manifests than expected',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0002',
             status: 422,
+            description: `Too many manifest files were provided in the request body.`,
             errorCode: 'SNYK-OS-PYTHON-0002',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -2154,6 +2479,7 @@ exports.TooManyManifestFilesError = TooManyManifestFilesError;
  * @summary Failed to apply dependency updates
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2165,6 +2491,7 @@ class FailedToApplyDependencyUpdatesError extends problem_error_1.ProblemError {
             title: 'Failed to apply dependency updates',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0003',
             status: 422,
+            description: `An error occurred while updating dependencies.`,
             errorCode: 'SNYK-OS-PYTHON-0003',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -2182,6 +2509,7 @@ exports.FailedToApplyDependencyUpdatesError = FailedToApplyDependencyUpdatesErro
  * @summary Python package not found
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2193,6 +2521,8 @@ class PythonPackageNotFoundError extends problem_error_1.ProblemError {
             title: 'Python package not found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0004',
             status: 422,
+            description: `A package listed in the manifest file cannot be found in the Python Package Index(PyPI).
+Make sure all packages included in the manifest file are public existing ones.`,
             errorCode: 'SNYK-OS-PYTHON-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2210,6 +2540,7 @@ exports.PythonPackageNotFoundError = PythonPackageNotFoundError;
  * @summary Syntax errors found in manifest file
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2221,6 +2552,8 @@ class SyntaxIssuesError extends problem_error_1.ProblemError {
             title: 'Syntax errors found in manifest file',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0005',
             status: 422,
+            description: `The manifest file has syntax issues like incorrect package names or unsupported characters.
+Make sure the manifest file follows the syntax stardards and can be installed locally as well.`,
             errorCode: 'SNYK-OS-PYTHON-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2239,6 +2572,7 @@ exports.SyntaxIssuesError = SyntaxIssuesError;
  * @summary Python version not supported
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2250,6 +2584,9 @@ class PipUnsupportedPythonVersionError extends problem_error_1.ProblemError {
             title: 'Python version not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0006',
             status: 422,
+            description: `At least one of the packages requires a Python version that doesn't match the one used in the project scan.
+Make sure to select a suitable Python version from the organization Python language settings.
+Alternatively, add a \`.snyk\` file for Python version selection override.`,
             errorCode: 'SNYK-OS-PYTHON-0006',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2267,6 +2604,7 @@ exports.PipUnsupportedPythonVersionError = PipUnsupportedPythonVersionError;
  * @summary Packages versions caused conflicts
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2278,6 +2616,8 @@ class PythonVersionConfictError extends problem_error_1.ProblemError {
             title: 'Packages versions caused conflicts',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0007',
             status: 422,
+            description: `Two or more packages have conflicting version requirements that cannot be resolved.
+Make sure no two packages and their requirements cause conflicts and that the manifest file can be installed locally.`,
             errorCode: 'SNYK-OS-PYTHON-0007',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2296,6 +2636,7 @@ exports.PythonVersionConfictError = PythonVersionConfictError;
  * @summary No matching distribution found for one or more of the packages
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2307,6 +2648,9 @@ class PipNoMatchingPythonDistributionError extends problem_error_1.ProblemError
             title: 'No matching distribution found for one or more of the packages',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0008',
             status: 422,
+            description: `At least one of the packages requires a Python version that doesn't match the one used in the project scan.
+Make sure to select a suitable Python version from the organization Python language settings.
+Alternatively, add a \`.snyk\` file for Python version selection override.`,
             errorCode: 'SNYK-OS-PYTHON-0008',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2323,6 +2667,7 @@ exports.PipNoMatchingPythonDistributionError = PipNoMatchingPythonDistributionEr
  * @summary Packages installation failed
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2334,6 +2679,7 @@ class InstallationFailureError extends problem_error_1.ProblemError {
             title: 'Packages installation failed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0009',
             status: 422,
+            description: `Some packages failed during installation due to missing system dependencies, compilation errors, or other package-specific issues.`,
             errorCode: 'SNYK-OS-PYTHON-0009',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -2351,6 +2697,7 @@ exports.InstallationFailureError = InstallationFailureError;
  * @summary Python version not supported
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2362,6 +2709,8 @@ class PipenvUnsupportedPythonVersionError extends problem_error_1.ProblemError {
             title: 'Python version not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0010',
             status: 422,
+            description: `At least one of the packages requires a Python version that doesn't match the one used in the project scan.
+Make sure to use the correct python version in the requires section of the Pipfile.`,
             errorCode: 'SNYK-OS-PYTHON-0010',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -2379,6 +2728,7 @@ exports.PipenvUnsupportedPythonVersionError = PipenvUnsupportedPythonVersionErro
  * @summary No matching distribution found for one or more of the packages
  * @category OpenSourceEcosystems
  * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
  * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
  * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
@@ -2390,6 +2740,8 @@ class PipenvNoMatchingPythonDistributionError extends problem_error_1.ProblemErr
             title: 'No matching distribution found for one or more of the packages',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-python-0011',
             status: 422,
+            description: `At least one of the packages requires a Python version that doesn't match the one used in the project scan.
+Make sure to use the correct python version in the requires section of the Pipfile.`,
             errorCode: 'SNYK-OS-PYTHON-0011',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,