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

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
  1. package/package.json +1 -1
  2. package/src/catalogs/CLI-error-catalog.d.ts +3 -0
  3. package/src/catalogs/CLI-error-catalog.js +8 -0
  4. package/src/catalogs/CLI-error-catalog.js.map +1 -1
  5. package/src/catalogs/Code-error-catalog.d.ts +98 -0
  6. package/src/catalogs/Code-error-catalog.js +190 -1
  7. package/src/catalogs/Code-error-catalog.js.map +1 -1
  8. package/src/catalogs/CustomBaseImages-error-catalog.d.ts +19 -0
  9. package/src/catalogs/CustomBaseImages-error-catalog.js +43 -0
  10. package/src/catalogs/CustomBaseImages-error-catalog.js.map +1 -1
  11. package/src/catalogs/Fix-error-catalog.d.ts +22 -0
  12. package/src/catalogs/Fix-error-catalog.js +44 -0
  13. package/src/catalogs/Fix-error-catalog.js.map +1 -1
  14. package/src/catalogs/Integration-error-catalog.d.ts +1 -0
  15. package/src/catalogs/Integration-error-catalog.js +2 -0
  16. package/src/catalogs/Integration-error-catalog.js.map +1 -1
  17. package/src/catalogs/IsolatedBuilds-error-catalog.d.ts +4 -0
  18. package/src/catalogs/IsolatedBuilds-error-catalog.js +13 -0
  19. package/src/catalogs/IsolatedBuilds-error-catalog.js.map +1 -1
  20. package/src/catalogs/OpenAPI-error-catalog.d.ts +8 -0
  21. package/src/catalogs/OpenAPI-error-catalog.js +16 -0
  22. package/src/catalogs/OpenAPI-error-catalog.js.map +1 -1
  23. package/src/catalogs/OpenSourceEcosystems-error-catalog.d.ts +77 -0
  24. package/src/catalogs/OpenSourceEcosystems-error-catalog.js +352 -0
  25. package/src/catalogs/OpenSourceEcosystems-error-catalog.js.map +1 -1
  26. package/src/catalogs/OpenSourceProjectIssues-error-catalog.d.ts +5 -0
  27. package/src/catalogs/OpenSourceProjectIssues-error-catalog.js +10 -0
  28. package/src/catalogs/OpenSourceProjectIssues-error-catalog.js.map +1 -1
  29. package/src/catalogs/OpenSourceProjectSnapshots-error-catalog.d.ts +5 -0
  30. package/src/catalogs/OpenSourceProjectSnapshots-error-catalog.js +10 -0
  31. package/src/catalogs/OpenSourceProjectSnapshots-error-catalog.js.map +1 -1
  32. package/src/catalogs/OpenSourceUnmanaged-error-catalog.d.ts +2 -0
  33. package/src/catalogs/OpenSourceUnmanaged-error-catalog.js +4 -0
  34. package/src/catalogs/OpenSourceUnmanaged-error-catalog.js.map +1 -1
  35. package/src/catalogs/PRChecks-error-catalog.d.ts +11 -0
  36. package/src/catalogs/PRChecks-error-catalog.js +61 -0
  37. package/src/catalogs/PRChecks-error-catalog.js.map +1 -1
  38. package/src/catalogs/Policies-error-catalog.d.ts +1 -0
  39. package/src/catalogs/Policies-error-catalog.js +3 -0
  40. package/src/catalogs/Policies-error-catalog.js.map +1 -1
  41. package/src/catalogs/PurlVulnerabilityFetching-error-catalog.d.ts +20 -0
  42. package/src/catalogs/PurlVulnerabilityFetching-error-catalog.js +40 -0
  43. package/src/catalogs/PurlVulnerabilityFetching-error-catalog.js.map +1 -1
  44. package/src/catalogs/SCM-error-catalog.d.ts +6 -0
  45. package/src/catalogs/SCM-error-catalog.js +16 -0
  46. package/src/catalogs/SCM-error-catalog.js.map +1 -1
  47. package/src/catalogs/SbomExport-error-catalog.d.ts +9 -0
  48. package/src/catalogs/SbomExport-error-catalog.js +18 -0
  49. package/src/catalogs/SbomExport-error-catalog.js.map +1 -1
  50. package/src/catalogs/SbomTest-error-catalog.d.ts +10 -0
  51. package/src/catalogs/SbomTest-error-catalog.js +29 -0
  52. package/src/catalogs/SbomTest-error-catalog.js.map +1 -1
  53. package/src/catalogs/Snyk-error-catalog.d.ts +8 -0
  54. package/src/catalogs/Snyk-error-catalog.js +23 -1
  55. package/src/catalogs/Snyk-error-catalog.js.map +1 -1
  56. package/src/catalogs/Target-error-catalog.d.ts +2 -0
  57. package/src/catalogs/Target-error-catalog.js +4 -0
  58. package/src/catalogs/Target-error-catalog.js.map +1 -1
  59. package/src/catalogs/error-codes.d.ts +5 -0
  60. package/src/catalogs/error-codes.js +5 -0
  61. package/src/catalogs/error-codes.js.map +1 -1
  62. package/src/problem-error.js +1 -1
  63. package/src/problem-error.js.map +1 -1
  64. package/src/types.d.ts +2 -1
  65. package/src/types.js.map +1 -1
@@ -28,6 +28,7 @@ const problem_error_1 = require("../problem-error");
28
28
  * @summary Invalid request
29
29
  * @category IsolatedBuilds
30
30
  * @param {string} details the specific details that causes this error
31
+ * @param {string} description the general description for this error
31
32
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
32
33
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
33
34
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -39,6 +40,7 @@ class InvalidRequestError extends problem_error_1.ProblemError {
39
40
  title: 'Invalid request',
40
41
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-8001',
41
42
  status: 400,
43
+ description: `The provided request payload is not valid for the selected ecosystem. Please review the API documentation.`,
42
44
  errorCode: 'SNYK-OS-8001',
43
45
  level: 'error',
44
46
  classification: types_1.Classification.ACTIONABLE,
@@ -57,6 +59,7 @@ exports.InvalidRequestError = InvalidRequestError;
57
59
  * @summary Build environment not found
58
60
  * @category IsolatedBuilds
59
61
  * @param {string} details the specific details that causes this error
62
+ * @param {string} description the general description for this error
60
63
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
61
64
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
62
65
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -68,6 +71,7 @@ class BuildEnvironmentNotFoundError extends problem_error_1.ProblemError {
68
71
  title: 'Build environment not found',
69
72
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-8002',
70
73
  status: 404,
74
+ description: `The build environment for the provided context could not be found. Please ensure you have created the build environment first.`,
71
75
  errorCode: 'SNYK-OS-8002',
72
76
  level: 'warn',
73
77
  classification: types_1.Classification.ACTIONABLE,
@@ -87,6 +91,7 @@ exports.BuildEnvironmentNotFoundError = BuildEnvironmentNotFoundError;
87
91
  * @summary Unsupported Ecosystem
88
92
  * @category IsolatedBuilds
89
93
  * @param {string} details the specific details that causes this error
94
+ * @param {string} description the general description for this error
90
95
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
91
96
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
92
97
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -98,6 +103,7 @@ class UnsupportedEcosystemError extends problem_error_1.ProblemError {
98
103
  title: 'Unsupported Ecosystem',
99
104
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-8003',
100
105
  status: 400,
106
+ description: `The language or package manager is not supported. Please refer to the supported package managers in the links.`,
101
107
  errorCode: 'SNYK-OS-8003',
102
108
  level: 'error',
103
109
  classification: types_1.Classification.ACTIONABLE,
@@ -124,6 +130,7 @@ exports.UnsupportedEcosystemError = UnsupportedEcosystemError;
124
130
  * @summary OAuth re-authorization required
125
131
  * @category IsolatedBuilds
126
132
  * @param {string} details the specific details that causes this error
133
+ * @param {string} description the general description for this error
127
134
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
128
135
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
129
136
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -135,6 +142,12 @@ class SsoReAuthRequiredError extends problem_error_1.ProblemError {
135
142
  title: 'OAuth re-authorization required',
136
143
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-os-8004',
137
144
  status: 422,
145
+ description: `Your code is cloned on an isolated environment using Git as it is required by Snyk to analyze its dependencies.
146
+
147
+ Your Organization has enabled or enforced SAML SSO after you authorized Snyk to access your code, and a re-authentication is therefore required.
148
+
149
+ The error you're seeing is usually reproducible by attempting to do a \`git clone\` of your repository with incorrectly configured credentials.
150
+ Verify your authentication configuration with your Git cloud provider and try again.`,
138
151
  errorCode: 'SNYK-OS-8004',
139
152
  level: 'error',
140
153
  classification: types_1.Classification.ACTIONABLE,
@@ -1 +1 @@
1
- {"version":3,"file":"IsolatedBuilds-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/IsolatedBuilds-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;GAcG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iBAAiB;YACxB,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;gBACP,0BAA0B;aACzB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,kDA8BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,6BAA8B,SAAQ,4BAAY;IAC7D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,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,sEA4BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,uBAAuB;YAC9B,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;gBACP,uLAAuL;aACtL,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,8DA8BC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iCAAiC;YACxC,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;gBACP,mMAAmM;aAClM,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wDA8BC"}
1
+ {"version":3,"file":"IsolatedBuilds-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/IsolatedBuilds-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,4GAA4G;YACzH,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,0BAA0B;aACzB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,kDA+BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,6BAA8B,SAAQ,4BAAY;IAC7D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,gIAAgI;YAC7I,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,sEA6BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,uBAAuB;YAC9B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,gHAAgH;YAC7H,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,uLAAuL;aACtL,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,8DA+BC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,iCAAiC;YACxC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;;qFAKgE;YAC7E,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,mMAAmM;aAClM,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AApCD,wDAoCC"}
@@ -24,6 +24,7 @@ import { ProblemError } from '../problem-error';
24
24
  * @summary Bad request
25
25
  * @category OpenAPI
26
26
  * @param {string} details the specific details that causes this error
27
+ * @param {string} description the general description for this error
27
28
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
28
29
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
29
30
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -39,6 +40,7 @@ export declare class BadRequestError extends ProblemError {
39
40
  * @summary Forbidden
40
41
  * @category OpenAPI
41
42
  * @param {string} details the specific details that causes this error
43
+ * @param {string} description the general description for this error
42
44
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
43
45
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
44
46
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -54,6 +56,7 @@ export declare class ForbiddenError extends ProblemError {
54
56
  * @summary Not acceptable
55
57
  * @category OpenAPI
56
58
  * @param {string} details the specific details that causes this error
59
+ * @param {string} description the general description for this error
57
60
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
58
61
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
59
62
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -69,6 +72,7 @@ export declare class NotAcceptableError extends ProblemError {
69
72
  * @summary Not found
70
73
  * @category OpenAPI
71
74
  * @param {string} details the specific details that causes this error
75
+ * @param {string} description the general description for this error
72
76
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
73
77
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
74
78
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -84,6 +88,7 @@ export declare class NotFoundError extends ProblemError {
84
88
  * @summary Method not allowed
85
89
  * @category OpenAPI
86
90
  * @param {string} details the specific details that causes this error
91
+ * @param {string} description the general description for this error
87
92
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
88
93
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
89
94
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -99,6 +104,7 @@ export declare class MethodNotAllowedError extends ProblemError {
99
104
  * @summary Request entity too large
100
105
  * @category OpenAPI
101
106
  * @param {string} details the specific details that causes this error
107
+ * @param {string} description the general description for this error
102
108
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
103
109
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
104
110
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -117,6 +123,7 @@ export declare class RequestEntityTooLargeError extends ProblemError {
117
123
  * @summary Unauthorized
118
124
  * @category OpenAPI
119
125
  * @param {string} details the specific details that causes this error
126
+ * @param {string} description the general description for this error
120
127
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
121
128
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
122
129
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -132,6 +139,7 @@ export declare class UnauthorizedError extends ProblemError {
132
139
  * @summary Unsupported media type
133
140
  * @category OpenAPI
134
141
  * @param {string} details the specific details that causes this error
142
+ * @param {string} description the general description for this error
135
143
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
136
144
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
137
145
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -28,6 +28,7 @@ const problem_error_1 = require("../problem-error");
28
28
  * @summary Bad request
29
29
  * @category OpenAPI
30
30
  * @param {string} details the specific details that causes this error
31
+ * @param {string} description the general description for this error
31
32
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
32
33
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
33
34
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -39,6 +40,7 @@ class BadRequestError extends problem_error_1.ProblemError {
39
40
  title: 'Bad request',
40
41
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0001',
41
42
  status: 400,
43
+ description: `The server cannot process the request due to invalid or corrupt data. Review the request, then try again.`,
42
44
  errorCode: 'SNYK-OPENAPI-0001',
43
45
  level: 'warn',
44
46
  classification: types_1.Classification.ACTIONABLE,
@@ -57,6 +59,7 @@ exports.BadRequestError = BadRequestError;
57
59
  * @summary Forbidden
58
60
  * @category OpenAPI
59
61
  * @param {string} details the specific details that causes this error
62
+ * @param {string} description the general description for this error
60
63
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
61
64
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
62
65
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -68,6 +71,7 @@ class ForbiddenError extends problem_error_1.ProblemError {
68
71
  title: 'Forbidden',
69
72
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0002',
70
73
  status: 403,
74
+ description: `Access to the requested resource is forbidden. Review the request, then try again.`,
71
75
  errorCode: 'SNYK-OPENAPI-0002',
72
76
  level: 'warn',
73
77
  classification: types_1.Classification.ACTIONABLE,
@@ -84,6 +88,7 @@ exports.ForbiddenError = ForbiddenError;
84
88
  * @summary Not acceptable
85
89
  * @category OpenAPI
86
90
  * @param {string} details the specific details that causes this error
91
+ * @param {string} description the general description for this error
87
92
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
88
93
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
89
94
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -95,6 +100,7 @@ class NotAcceptableError extends problem_error_1.ProblemError {
95
100
  title: 'Not acceptable',
96
101
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0003',
97
102
  status: 406,
103
+ description: `The server cannot provide a response that matches the provided accept headers. Review the request, then try again.`,
98
104
  errorCode: 'SNYK-OPENAPI-0003',
99
105
  level: 'warn',
100
106
  classification: types_1.Classification.ACTIONABLE,
@@ -111,6 +117,7 @@ exports.NotAcceptableError = NotAcceptableError;
111
117
  * @summary Not found
112
118
  * @category OpenAPI
113
119
  * @param {string} details the specific details that causes this error
120
+ * @param {string} description the general description for this error
114
121
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
115
122
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
116
123
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -122,6 +129,7 @@ class NotFoundError extends problem_error_1.ProblemError {
122
129
  title: 'Not found',
123
130
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0004',
124
131
  status: 404,
132
+ description: `The server cannot find the requested resource. Review the request, then try again.`,
125
133
  errorCode: 'SNYK-OPENAPI-0004',
126
134
  level: 'warn',
127
135
  classification: types_1.Classification.ACTIONABLE,
@@ -138,6 +146,7 @@ exports.NotFoundError = NotFoundError;
138
146
  * @summary Method not allowed
139
147
  * @category OpenAPI
140
148
  * @param {string} details the specific details that causes this error
149
+ * @param {string} description the general description for this error
141
150
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
142
151
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
143
152
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -149,6 +158,7 @@ class MethodNotAllowedError extends problem_error_1.ProblemError {
149
158
  title: 'Method not allowed',
150
159
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0005',
151
160
  status: 405,
161
+ description: `The target endpoint does not support your request method. Review the request, then try again.`,
152
162
  errorCode: 'SNYK-OPENAPI-0005',
153
163
  level: 'warn',
154
164
  classification: types_1.Classification.ACTIONABLE,
@@ -165,6 +175,7 @@ exports.MethodNotAllowedError = MethodNotAllowedError;
165
175
  * @summary Request entity too large
166
176
  * @category OpenAPI
167
177
  * @param {string} details the specific details that causes this error
178
+ * @param {string} description the general description for this error
168
179
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
169
180
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
170
181
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -176,6 +187,7 @@ class RequestEntityTooLargeError extends problem_error_1.ProblemError {
176
187
  title: 'Request entity too large',
177
188
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0006',
178
189
  status: 413,
190
+ description: `The request entity exceeds server limitations. Reduce the size of the request entity, then try again.`,
179
191
  errorCode: 'SNYK-OPENAPI-0006',
180
192
  level: 'warn',
181
193
  classification: types_1.Classification.ACTIONABLE,
@@ -195,6 +207,7 @@ exports.RequestEntityTooLargeError = RequestEntityTooLargeError;
195
207
  * @summary Unauthorized
196
208
  * @category OpenAPI
197
209
  * @param {string} details the specific details that causes this error
210
+ * @param {string} description the general description for this error
198
211
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
199
212
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
200
213
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -206,6 +219,7 @@ class UnauthorizedError extends problem_error_1.ProblemError {
206
219
  title: 'Unauthorized',
207
220
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0007',
208
221
  status: 401,
222
+ description: `The request lacks authentication credentials for the requested resource. Ensure you are sending valid credentials, then try again.`,
209
223
  errorCode: 'SNYK-OPENAPI-0007',
210
224
  level: 'warn',
211
225
  classification: types_1.Classification.ACTIONABLE,
@@ -224,6 +238,7 @@ exports.UnauthorizedError = UnauthorizedError;
224
238
  * @summary Unsupported media type
225
239
  * @category OpenAPI
226
240
  * @param {string} details the specific details that causes this error
241
+ * @param {string} description the general description for this error
227
242
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
228
243
  * @param {Record<string, any>} [additionalData] a collection of relevant data specific to this error
229
244
  * @param {Error} [cause] the `Error` type that caused this error to be thrown
@@ -235,6 +250,7 @@ class UnsupportedMediaTypeError extends problem_error_1.ProblemError {
235
250
  title: 'Unsupported media type',
236
251
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-openapi-0008',
237
252
  status: 415,
253
+ description: `The media format of the request is not supported. Change media format, then try again.`,
238
254
  errorCode: 'SNYK-OPENAPI-0008',
239
255
  level: 'warn',
240
256
  classification: types_1.Classification.ACTIONABLE,
@@ -1 +1 @@
1
- {"version":3,"file":"OpenAPI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/OpenAPI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;GAcG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yEAAyE;aACxE,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,0CA8BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,cAAe,SAAQ,4BAAY;IAC9C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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,wCA4BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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,WAAW;YAClB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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;;;;;;;;;;;GAWG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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,0BAA2B,SAAQ,4BAAY;IAC1D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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,gEA4BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IACjD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,8CA8BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,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,8DA4BC"}
1
+ {"version":3,"file":"OpenAPI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/OpenAPI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,2GAA2G;YACxH,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yEAAyE;aACxE,IACE,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;;;;;;;;;;;;GAYG;AACH,MAAa,cAAe,SAAQ,4BAAY;IAC9C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,oFAAoF;YACjG,SAAS,EAAE,mBAAmB;YAC9B,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,wCA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,oHAAoH;YACjI,SAAS,EAAE,mBAAmB;YAC9B,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,gDA6BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,oFAAoF;YACjG,SAAS,EAAE,mBAAmB;YAC9B,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;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,+FAA+F;YAC5G,SAAS,EAAE,mBAAmB;YAC9B,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,0BAA2B,SAAQ,4BAAY;IAC1D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,uGAAuG;YACpH,SAAS,EAAE,mBAAmB;YAC9B,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,gEA6BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IACjD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,oIAAoI;YACjJ,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA/BD,8CA+BC;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,qEAAqE;YAC3E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE,wFAAwF;YACrG,SAAS,EAAE,mBAAmB;YAC9B,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,8DA6BC"}