Skip to content

Commit 11e9cbd

Browse files
committed
lets add an explanation to why this has been closed off
1 parent c47aa07 commit 11e9cbd

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/Convertor.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
const traverse = require("json-schema-traverse");
44
const { v4: uuid } = require("uuid");
55
const cloneDeep = require("lodash.clonedeep");
6+
const packageData = require("../package.json");
67

78
class Convertor {
89
constructor(schema = {}) {
@@ -112,7 +113,9 @@ class Convertor {
112113

113114
for (const reportDetail of report) {
114115
try {
115-
this.closingTheCircle(this.schema, reportDetail.duplicate, {});
116+
this.closingTheCircle(this.schema, reportDetail.duplicate, {
117+
description: `This was found to be a circular reference and has been closed off to avoid repetitive processing. This closure was made by json-schema-for-openapi v${packageData.version} - please open an issue at: ${packageData.bugs}`,
118+
});
116119
} catch (err) {
117120
console.error(err);
118121
throw err;

0 commit comments

Comments
 (0)