npm - @snyk/error-catalog-nodejs-public - Versions diffs - 5.33.0 → 5.34.1 - Mend

@snyk/error-catalog-nodejs-public 5.33.0 → 5.34.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

package/src/catalogs/SbomExport-error-catalog.js CHANGED Viewed

@@ -25,6 +25,7 @@ const problem_error_1 = require("../problem-error");
  * @summary SBOM generation export server error
  * @category SbomExport
  * @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
@@ -36,6 +37,7 @@ class InternalServerError extends problem_error_1.ProblemError {
             title: 'SBOM generation export server error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9000',
             status: 500,
+            description: `An unexpected error occurred during the SBOM generation. Review the request, then try again. If the error persists, contact Snyk Support.`,
             errorCode: 'SNYK-OS-9000',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -52,6 +54,7 @@ exports.InternalServerError = InternalServerError;
  * @summary Dependency graph error
  * @category SbomExport
  * @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
@@ -63,6 +66,7 @@ class UnexpectedDepGraphResponseError extends problem_error_1.ProblemError {
             title: 'Dependency graph error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9001',
             status: 500,
+            description: `An unexpected dependency graph error occurred. Review the request, then try again. If the error persists, contact Snyk Support.`,
             errorCode: 'SNYK-OS-9001',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -79,6 +83,7 @@ exports.UnexpectedDepGraphResponseError = UnexpectedDepGraphResponseError;
  * @summary Error parsing dependency graph
  * @category SbomExport
  * @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
@@ -90,6 +95,7 @@ class UnexpectedParseDepGraphError extends problem_error_1.ProblemError {
             title: 'Error parsing dependency graph',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9002',
             status: 500,
+            description: `The dependency graph cannot be parsed due to an unexpected error. Review the request, then try again. If the error persists, contact Snyk Support.`,
             errorCode: 'SNYK-OS-9002',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -106,6 +112,7 @@ exports.UnexpectedParseDepGraphError = UnexpectedParseDepGraphError;
  * @summary SBOM not supported due to project type
  * @category SbomExport
  * @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
@@ -117,6 +124,7 @@ class IaCOrSASTProjectError extends problem_error_1.ProblemError {
             title: 'SBOM not supported due to project type',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9003',
             status: 404,
+            description: `Only SBOMs for Snyk Open Source or Snyk Container projects are supported.`,
             errorCode: 'SNYK-OS-9003',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -133,6 +141,7 @@ exports.IaCOrSASTProjectError = IaCOrSASTProjectError;
  * @summary SBOM not supported
  * @category SbomExport
  * @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
@@ -144,6 +153,7 @@ class UnsupportedProjectError extends problem_error_1.ProblemError {
             title: 'SBOM not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9004',
             status: 404,
+            description: `Only SBOMs for open source projects are supported (Snyk Open Source).`,
             errorCode: 'SNYK-OS-9004',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -160,6 +170,7 @@ exports.UnsupportedProjectError = UnsupportedProjectError;
  * @summary Dependency graph request cannot be processed
  * @category SbomExport
  * @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
@@ -171,6 +182,7 @@ class DepGraphResponseError extends problem_error_1.ProblemError {
             title: 'Dependency graph request cannot be processed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9005',
             status: 404,
+            description: `The server cannot process the request due to incomplete data. Review the request, then try again.`,
             errorCode: 'SNYK-OS-9005',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -190,6 +202,7 @@ exports.DepGraphResponseError = DepGraphResponseError;
  * @summary Authorization failed due to missing API token
  * @category SbomExport
  * @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
@@ -201,6 +214,7 @@ class MissingAuthTokenError extends problem_error_1.ProblemError {
             title: 'Authorization failed due to missing API token',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9006',
             status: 401,
+            description: `The API token is misconfigured or expired. Configure or generate the API token, then try again.`,
             errorCode: 'SNYK-OS-9006',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -219,6 +233,7 @@ exports.MissingAuthTokenError = MissingAuthTokenError;
  * @summary Client request cannot be processed
  * @category SbomExport
  * @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
@@ -230,6 +245,7 @@ class EmptyRequestBodyError extends problem_error_1.ProblemError {
             title: 'Client request cannot be processed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9007',
             status: 400,
+            description: `The body of the request is empty. Review the request, then try again.`,
             errorCode: 'SNYK-OS-9007',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -246,6 +262,7 @@ exports.EmptyRequestBodyError = EmptyRequestBodyError;
  * @summary Invalid dependency graph
  * @category SbomExport
  * @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
@@ -257,6 +274,7 @@ class InvalidDepGraphError extends problem_error_1.ProblemError {
             title: 'Invalid dependency graph',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-9008',
             status: 422,
+            description: `The supplied dependency graph was not valid. Review the request, then try again.`,
             errorCode: 'SNYK-OS-9008',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,

package/src/catalogs/SbomExport-error-catalog.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SbomExport-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/SbomExport-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD~~;;;;;;;;;;;GAWG~~;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qCAAqC;YAC5C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~kDA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,+BAAgC,SAAQ,4BAAY;IAC/D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~0EA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,gCAAgC;YACvC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~oEA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wCAAwC;YAC/C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sDA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~0DA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8CAA8C;YACrD,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sDA4BC~~;AAED~~;;;;;;;;;;;;;;GAcG~~;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,+CAA+C;YACtD,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,8EAA8E;aAC7E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA9BD~~,~~sDA8BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sDA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~oDA4BC~~"}
1	+ {"version":3,"file":"SbomExport-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/SbomExport-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qCAAqC;YAC5C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,2IAA2I;YACxJ,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,kDA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,+BAAgC,SAAQ,4BAAY;IAC/D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,iIAAiI;YAC9I,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,0EA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,gCAAgC;YACvC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,oJAAoJ;YACjK,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,oEA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wCAAwC;YAC/C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,2EAA2E;YACxF,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sDA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,uEAAuE;YACpF,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,0DA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8CAA8C;YACrD,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,mGAAmG;YAChH,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sDA6BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,+CAA+C;YACtD,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,iGAAiG;YAC9G,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,8EAA8E;aAC7E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,sDA+BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,uEAAuE;YACpF,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sDA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,kFAAkF;YAC/F,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,oDA6BC"}

package/src/catalogs/SbomTest-error-catalog.d.ts CHANGED Viewed

@@ -21,6 +21,7 @@ import { ProblemError } from '../problem-error';
  * @summary SBOM test error
  * @category SbomTest
  * @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
@@ -39,6 +40,7 @@ export declare class InternalError extends ProblemError {
  * @summary Organization ID mismatch
  * @category SbomTest
  * @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
@@ -54,6 +56,7 @@ export declare class OrgIDMismatchError extends ProblemError {
  * @summary Unable to find SBOM test
  * @category SbomTest
  * @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
@@ -71,6 +74,7 @@ export declare class NotFoundError extends ProblemError {
  * @summary SBOM test failed
  * @category SbomTest
  * @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
@@ -88,6 +92,7 @@ export declare class FailedTestError extends ProblemError {
  * @summary SBOM test results still pending
  * @category SbomTest
  * @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
@@ -108,6 +113,7 @@ export declare class PendingTestError extends ProblemError {
  * @summary Unknown SBOM format
  * @category SbomTest
  * @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
@@ -126,6 +132,7 @@ export declare class FormatUnknownError extends ProblemError {
  * @summary Unable to process SBOM input
  * @category SbomTest
  * @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
@@ -144,6 +151,7 @@ export declare class UnprocessableInputError extends ProblemError {
  * @summary SBOM format not supported
  * @category SbomTest
  * @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
@@ -159,6 +167,7 @@ export declare class FormatNotSupportedError extends ProblemError {
  * @summary SBOM analysis failed
  * @category SbomTest
  * @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
@@ -174,6 +183,7 @@ export declare class ConversionFailedError extends ProblemError {
  * @summary No testable packages found
  * @category SbomTest
  * @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

package/src/catalogs/SbomTest-error-catalog.js CHANGED Viewed

@@ -25,6 +25,7 @@ const problem_error_1 = require("../problem-error");
  * @summary SBOM test error
  * @category SbomTest
  * @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
@@ -36,6 +37,7 @@ class InternalError extends problem_error_1.ProblemError {
             title: 'SBOM test error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0001',
             status: 500,
+            description: `An unexpected error occurred. Review the request, then try again. If the error persists, contact Snyk Support.`,
             errorCode: 'SNYK-SBOM-0001',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -55,6 +57,7 @@ exports.InternalError = InternalError;
  * @summary Organization ID mismatch
  * @category SbomTest
  * @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
@@ -66,6 +69,10 @@ class OrgIDMismatchError extends problem_error_1.ProblemError {
             title: 'Organization ID mismatch',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0002',
             status: 404,
+            description: `The requested organization ID does not match the owner of the SBOM test ID.
+This error occurs when the supplied organization ID is different to the one used when creating an SBOM test run.
+Ensure the organization ID used to make the request is the same as the the organization ID used to create the SBOM test.`,
             errorCode: 'SNYK-SBOM-0002',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -82,6 +89,7 @@ exports.OrgIDMismatchError = OrgIDMismatchError;
  * @summary Unable to find SBOM test
  * @category SbomTest
  * @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
@@ -93,6 +101,7 @@ class NotFoundError extends problem_error_1.ProblemError {
             title: 'Unable to find SBOM test',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0003',
             status: 404,
+            description: `Snyk was unable to find the requested SBOM test.`,
             errorCode: 'SNYK-SBOM-0003',
             level: 'warn',
             classification: types_1.Classification.UNEXPECTED,
@@ -111,6 +120,7 @@ exports.NotFoundError = NotFoundError;
  * @summary SBOM test failed
  * @category SbomTest
  * @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
@@ -122,6 +132,9 @@ class FailedTestError extends problem_error_1.ProblemError {
             title: 'SBOM test failed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0004',
             status: 404,
+            description: `The SBOM test failed and does not have any results.
+This error occurs when results for a failed SBOM test are being requested.`,
             errorCode: 'SNYK-SBOM-0004',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -140,6 +153,7 @@ exports.FailedTestError = FailedTestError;
  * @summary SBOM test results still pending
  * @category SbomTest
  * @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
@@ -151,6 +165,9 @@ class PendingTestError extends problem_error_1.ProblemError {
             title: 'SBOM test results still pending',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0005',
             status: 404,
+            description: `The SBOM test is still processing and does not have any results yet.
+This error occurs when the results for an SBOM test have been requested, but the SBOM test is still being processed.`,
             errorCode: 'SNYK-SBOM-0005',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -172,6 +189,7 @@ exports.PendingTestError = PendingTestError;
  * @summary Unknown SBOM format
  * @category SbomTest
  * @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
@@ -183,6 +201,9 @@ class FormatUnknownError extends problem_error_1.ProblemError {
             title: 'Unknown SBOM format',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0006',
             status: 422,
+            description: `Snyk does not recognize the SBOM file format.
+Provide an SBOM document with a supported format.`,
             errorCode: 'SNYK-SBOM-0006',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -204,6 +225,7 @@ exports.FormatUnknownError = FormatUnknownError;
  * @summary Unable to process SBOM input
  * @category SbomTest
  * @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
@@ -215,6 +237,7 @@ class UnprocessableInputError extends problem_error_1.ProblemError {
             title: 'Unable to process SBOM input',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0007',
             status: 422,
+            description: `Snyk is unable to decode the SBOM file. Provide a valid SBOM document and try again.`,
             errorCode: 'SNYK-SBOM-0007',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -236,6 +259,7 @@ exports.UnprocessableInputError = UnprocessableInputError;
  * @summary SBOM format not supported
  * @category SbomTest
  * @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
@@ -247,6 +271,7 @@ class FormatNotSupportedError extends problem_error_1.ProblemError {
             title: 'SBOM format not supported',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0008',
             status: 422,
+            description: `Provide a supported format of the SBOM document and try again.`,
             errorCode: 'SNYK-SBOM-0008',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -265,6 +290,7 @@ exports.FormatNotSupportedError = FormatNotSupportedError;
  * @summary SBOM analysis failed
  * @category SbomTest
  * @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
@@ -276,6 +302,7 @@ class ConversionFailedError extends problem_error_1.ProblemError {
             title: 'SBOM analysis failed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0009',
             status: 422,
+            description: `Snyk was unable to process the provided SBOM input and is unable to scan it for issues.`,
             errorCode: 'SNYK-SBOM-0009',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,
@@ -292,6 +319,7 @@ exports.ConversionFailedError = ConversionFailedError;
  * @summary No testable packages found
  * @category SbomTest
  * @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
@@ -303,6 +331,7 @@ class NoTestablePackagesError extends problem_error_1.ProblemError {
             title: 'No testable packages found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-sbom-0010',
             status: 422,
+            description: `The SBOM document you provided does not contain any packages supported by Snyk vulnerability analysis, or it does not contain any package.`,
             errorCode: 'SNYK-SBOM-0010',
             level: 'warn',
             classification: types_1.Classification.UNSUPPORTED,

package/src/catalogs/SbomTest-error-catalog.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SbomTest-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/SbomTest-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD~~;;;;;;;;;;;GAWG~~;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sCA4BC~~;AAED~~;;;;;;;;;;;;;;GAcG~~;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~gDA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sCA4BC~~;AAED~~;;;;;;;;;;;;;GAaG~~;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,kBAAkB;YACzB,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~0CA4BC~~;AAED~~;;;;;;;;;;;;;GAaG~~;AACH,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iCAAiC;YACxC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~4CA4BC~~;AAED~~;;;;;;;;;;;;;;;;GAgBG~~;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA9BD~~,~~gDA8BC~~;AAED~~;;;;;;;;;;;;;;GAcG~~;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8BAA8B;YACrC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA9BD~~,~~0DA8BC~~;AAED~~;;;;;;;;;;;;;;GAcG~~;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA9BD~~,~~0DA8BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~sDA4BC~~;AAED~~;;;;;;;;;;;GAWG~~;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;~~AA5BD~~,~~0DA4BC~~"}
1	+ {"version":3,"file":"SbomTest-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/SbomTest-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,gHAAgH;YAC7H,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sCA6BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;yHAGoG;YACjH,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAhCD,gDAgCC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,kDAAkD;YAC/D,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sCA6BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,kBAAkB;YACzB,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;2EAEsD;YACnE,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,0CA+BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iCAAiC;YACxC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;qHAEgG;YAC7G,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,4CA+BC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;kDAE6B;YAC1C,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAjCD,gDAiCC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8BAA8B;YACrC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,sFAAsF;YACnG,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,0DA+BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,gEAAgE;YAC7E,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,kDAAkD;aACjD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,0DA+BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,yFAAyF;YACtG,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,sDA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,kEAAkE;YACxE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,4IAA4I;YACzJ,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA7BD,0DA6BC"}

package/src/catalogs/Snyk-error-catalog.d.ts CHANGED Viewed

@@ -21,6 +21,7 @@ import { ProblemError } from '../problem-error';
  * @summary Service temporarily throttled
  * @category Snyk
  * @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
@@ -39,6 +40,7 @@ export declare class TooManyRequestsError extends ProblemError {
  * @summary Server error response
  * @category Snyk
  * @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
@@ -54,6 +56,7 @@ export declare class NotImplementedError extends ProblemError {
  * @summary Client request cannot be processed
  * @category Snyk
  * @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
@@ -72,6 +75,7 @@ export declare class BadRequestError extends ProblemError {
  * @summary Server communication error
  * @category Snyk
  * @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
@@ -87,6 +91,7 @@ export declare class TimeoutError extends ProblemError {
  * @summary Authentication error
  * @category Snyk
  * @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
@@ -107,6 +112,7 @@ export declare class UnauthorisedError extends ProblemError {
  * @summary Test limit reached
  * @category Snyk
  * @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
@@ -131,6 +137,7 @@ export declare class TestLimitReachedError extends ProblemError {
  * @summary Organization is not part of a group
  * @category Snyk
  * @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
@@ -149,6 +156,7 @@ export declare class TagsForOrganizationWithoutGroupError extends ProblemError {
  * @summary Request not fulfilled due to server error
  * @category Snyk
  * @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

package/src/catalogs/Snyk-error-catalog.js CHANGED Viewed

@@ -25,6 +25,7 @@ const problem_error_1 = require("../problem-error");
  * @summary Service temporarily throttled
  * @category Snyk
  * @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
@@ -36,6 +37,7 @@ class TooManyRequestsError extends problem_error_1.ProblemError {
             title: 'Service temporarily throttled',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0001',
             status: 429,
+            description: `The request rate limit has been exceeded. Wait a few minutes, then try again.`,
             errorCode: 'SNYK-0001',
             level: 'warn',
             classification: types_1.Classification.ACTIONABLE,
@@ -55,6 +57,7 @@ exports.TooManyRequestsError = TooManyRequestsError;
  * @summary Server error response
  * @category Snyk
  * @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
@@ -66,6 +69,7 @@ class NotImplementedError extends problem_error_1.ProblemError {
             title: 'Server error response',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0002',
             status: 501,
+            description: `The server doesn't recognize the request method, or it cannot fulfill it. Review the request and try again.`,
             errorCode: 'SNYK-0002',
             level: 'error',
             classification: types_1.Classification.UNSUPPORTED,
@@ -84,6 +88,7 @@ exports.NotImplementedError = NotImplementedError;
  * @summary Client request cannot be processed
  * @category Snyk
  * @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
@@ -95,6 +100,7 @@ class BadRequestError extends problem_error_1.ProblemError {
             title: 'Client request cannot be processed',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0003',
             status: 400,
+            description: `The server cannot process the request due to a client error, such as malformed request syntax, size too large, invalid request message framing, or deceptive request routing. Review the request and try again.`,
             errorCode: 'SNYK-0003',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -114,6 +120,7 @@ exports.BadRequestError = BadRequestError;
  * @summary Server communication error
  * @category Snyk
  * @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
@@ -125,6 +132,7 @@ class TimeoutError extends problem_error_1.ProblemError {
             title: 'Server communication error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0004',
             status: 504,
+            description: `The server timed out during the request. Check Snyk status, then try again.`,
             errorCode: 'SNYK-0004',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -143,6 +151,7 @@ exports.TimeoutError = TimeoutError;
  * @summary Authentication error
  * @category Snyk
  * @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
@@ -154,6 +163,7 @@ class UnauthorisedError extends problem_error_1.ProblemError {
             title: 'Authentication error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0005',
             status: 401,
+            description: `Authentication credentials not recognized, or user access is not provisioned. Revise credentials and try again, or request access from your Snyk administrator.`,
             errorCode: 'SNYK-0005',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -175,6 +185,7 @@ exports.UnauthorisedError = UnauthorisedError;
  * @summary Test limit reached
  * @category Snyk
  * @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
@@ -186,6 +197,7 @@ class TestLimitReachedError extends problem_error_1.ProblemError {
             title: 'Test limit reached',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0006',
             status: 429,
+            description: `You have reached the maximum number of tests in your Snyk plan. This causes Snyk tests on PRs and CLI to fail. Deactivate Snyk Test on your Project or upgrade your Snyk plan.`,
             errorCode: 'SNYK-0006',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -215,6 +227,7 @@ exports.TestLimitReachedError = TestLimitReachedError;
  * @summary Organization is not part of a group
  * @category Snyk
  * @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
@@ -226,6 +239,13 @@ class TagsForOrganizationWithoutGroupError extends problem_error_1.ProblemError
             title: 'Organization is not part of a group',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0007',
             status: 422,
+            description: `This error occures when trying to add tags to Organizations that that are part of a Group.
+Verify with your Group Admin if the Organization should be in a Group.
+If you have more than one Organization, you can set the Organization with which new Projects should be associated by running \`snyk config set org=ORG_ID\`.
+If you want to override this global configuration for individual runs of snyk monitor, \`run snyk test --org=ORG_ID\` or \`snyk monitor --org=ORG_ID\`.`,
             errorCode: 'SNYK-0007',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -247,6 +267,7 @@ exports.TagsForOrganizationWithoutGroupError = TagsForOrganizationWithoutGroupEr
  * @summary Request not fulfilled due to server error
  * @category Snyk
  * @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 +279,7 @@ class ServerError extends problem_error_1.ProblemError {
             title: 'Request not fulfilled due to server error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-9999',
             status: 500,
+            description: `The server cannot process the request due to an unexpected error. Check Snyk status, then try again.`,
             errorCode: 'SNYK-9999',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,