@snyk/error-catalog-nodejs-public 3.16.0

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

@@ -0,0 +1,215 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnsupportedMediaTypeError = exports.UnauthorizedError = exports.RequestEntityTooLargeError = exports.MethodNotAllowedError = exports.NotFoundError = exports.NotAcceptableError = exports.ForbiddenError = exports.BadRequestError = void 0;
+const problem_error_1 = require("../problem-error");
+/**
+ * @class
+ * @name BadRequestError
+ * @description The server cannot process the request due to invalid or corrupt data. Review the request, then try again.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-api-info/getting-started-using-snyk-rest-api ](https://docs.snyk.io/snyk-api-info/getting-started-using-snyk-rest-api )
+ * @summary Bad request
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class BadRequestError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Bad request',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0001',
+            status: 400,
+            errorCode: 'SNYK-OPENAPI-0001',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-api-info/getting-started-using-snyk-rest-api ',
+            ] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.BadRequestError = BadRequestError;
+/**
+ * @class
+ * @name ForbiddenError
+ * @description Access to the requested resource is forbidden.
+ * @summary Forbidden
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class ForbiddenError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Forbidden',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0002',
+            status: 403,
+            errorCode: 'SNYK-OPENAPI-0002',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+/**
+ * @class
+ * @name NotAcceptableError
+ * @description The server cannot provide a response that matches the provided accept headers. Review the request, then try again.
+ * @summary Not acceptable
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class NotAcceptableError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Not acceptable',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0003',
+            status: 406,
+            errorCode: 'SNYK-OPENAPI-0003',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.NotAcceptableError = NotAcceptableError;
+/**
+ * @class
+ * @name NotFoundError
+ * @description The server cannot find the requested resource.
+ * @summary Not found
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class NotFoundError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Not found',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0004',
+            status: 404,
+            errorCode: 'SNYK-OPENAPI-0004',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.NotFoundError = NotFoundError;
+/**
+ * @class
+ * @name MethodNotAllowedError
+ * @description The target endpoint does not support your request method. Review the request, then try again.
+ * @summary Method not allowed
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class MethodNotAllowedError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Method not allowed',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0005',
+            status: 405,
+            errorCode: 'SNYK-OPENAPI-0005',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.MethodNotAllowedError = MethodNotAllowedError;
+/**
+ * @class
+ * @name RequestEntityTooLargeError
+ * @description The request entity exceeds server limitations.
+ * @summary Request entity too large
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class RequestEntityTooLargeError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Request entity too large',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0006',
+            status: 413,
+            errorCode: 'SNYK-OPENAPI-0006',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.RequestEntityTooLargeError = RequestEntityTooLargeError;
+/**
+ * @class
+ * @name UnauthorizedError
+ * @description The request lacks authentication credentials for the requested resource.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-api-info/authentication-for-api ](https://docs.snyk.io/snyk-api-info/authentication-for-api )
+ * @summary Unauthorized
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class UnauthorizedError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Unauthorized',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0007',
+            status: 401,
+            errorCode: 'SNYK-OPENAPI-0007',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-api-info/authentication-for-api ',
+            ] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;
+/**
+ * @class
+ * @name UnsupportedMediaTypeError
+ * @description The media format of the request is not supported.
+ * @summary Unsupported media type
+ * @category OpenAPI
+ * @param {string} details                         the specific details that causes this error
+ * @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
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class UnsupportedMediaTypeError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance) {
+        super({
+            title: 'Unsupported media type',
+            type: 'https://docs.snyk.io/more-info/error-catalog#snyk-openapi-0008',
+            status: 415,
+            errorCode: 'SNYK-OPENAPI-0008',
+            level: 'warn',
+            instance,
+        }, details, Object.assign({ links: [] }, additionalData), cause);
+        this.name = this.constructor.name;
+    }
+}
+exports.UnsupportedMediaTypeError = UnsupportedMediaTypeError;
+//# sourceMappingURL=OpenAPI-error-catalog.js.map

package/src/catalogs/OpenAPI-error-catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAPI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/OpenAPI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oDAAgD;AAEhD;;;;;;;;;;;;;GAaG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yEAAyE;aACxE,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA3BD,0CA2BC;AAED;;;;;;;;;;GAUG;AACH,MAAa,cAAe,SAAQ,4BAAY;IAC9C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,wCAyBC;AAED;;;;;;;;;;GAUG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,gDAyBC;AAED;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,4BAAY;IAC7C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,sCAyBC;AAED;;;;;;;;;;GAUG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,sDAyBC;AAED;;;;;;;;;;GAUG;AACH,MAAa,0BAA2B,SAAQ,4BAAY;IAC1D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,0BAA0B;YACjC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,gEAyBC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IACjD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,4DAA4D;aAC3D,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA3BD,8CA2BC;AAED;;;;;;;;;;GAUG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,mBAAmB;YAC9B,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,8DAyBC"}