Inline certain references rather than hoisting them (#13)

Author: P0lip

lib/bundle/defaults.js

@@ -54,6 +54,10 @@ module.exports.getDefaultsForOAS2 = function (defaults = getGenericDefaults(new
  generateKey (schema, file, hash, pathFromRoot) {
  pathFromRoot = normalizeOasSchemasHash(pathFromRoot, defaults.defaultRoot);
 
+ if (!pathFromRoot.startsWith(defaults.defaultRoot) && !isSchemaPlacement(pathFromRoot.split("/"))) {
+ return null;
+ }
+
  if (hash !== "#" && hash !== null) {
  return defaults.generateKey(schema, file, normalizeOasSchemasHash(hash, defaults.defaultRoot), pathFromRoot);
  }
@@ -70,3 +74,16 @@ module.exports.getDefaultsForOAS3 = function (defaults = getGenericDefaults(new
 function normalizeOasSchemasHash (hash, root) {
  return hash.replace(/\/(?:components\/schemas|definitions)\//g, root.slice(1) + "/");
 }
+
+// this should return true for every place in a OAS document that can reference a JSON Schema model
+function isSchemaPlacement (path) {
+ if (isInOasOperation(path) && path.includes("schema")) {
+ return true;
+ }
+
+ return false;
+}
+
+function isInOasOperation (path) {
+ return path.length > 3 && path[1] === "paths";
+}

lib/bundle/index.js

@@ -145,7 +145,7 @@ function inventory$Ref ($refParent, $refKey, path, pathFromRoot, indirections, i
  }
  }
 
- if (options.bundle.generateKey && file !== $refs._root$Ref.path) {
+ if (options.bundle.generateKey && file !== $refs._root$Ref.path && !(path.indexOf($refs._root$Ref.path) === 0 && $ref.$ref.indexOf("#/") === 0)) {
  if (!customRoots[file]) {
  customRoots[file] = {};
  }

test/specs/custom-bundling-roots-legacy-stoplight/reference/openapi-2-bundled.js

@@ -10,7 +10,10 @@ module.exports = {
  "/flight/{id}": {
  parameters: [
  {
- $ref: "#/definitions/Id"
+ in: "path",
+ name: "id",
+ required: true,
+ type: "number"
  }
  ],
  get: {
@@ -152,12 +155,6 @@ module.exports = {
  maxLength: 100,
  example: "747"
  },
- Id: {
- in: "path",
- name: "id",
- required: true,
- type: "number"
- },
  Manufacturer: {
  definitions: {},
  title: "Manufacturer",

test/specs/custom-bundling-roots-legacy-stoplight/reference/openapi-3.bundled.js

@@ -14,8 +14,11 @@ module.exports = {
  "/flight/{id}": {
  parameters: [
  {
- $ref: "#/components/schemas/Id"
- }
+ in: "path",
+ name: "id",
+ required: true,
+ type: "number"
+ },
  ],
  get: {
  operationId: "get-flights",
@@ -166,12 +169,6 @@ module.exports = {
  maxLength: 100,
  example: "747"
  },
- Id: {
- in: "path",
- name: "id",
- required: true,
- type: "number"
- },
  Manufacturer: {
  definitions: {},
  title: "Manufacturer",

test/specs/custom-bundling-roots/custom-bundling-roots.spec.js

@@ -5,7 +5,7 @@ const { expect } = require("chai");
 const $RefParser = require("../../..");
 const path = require("../../utils/path");
 const setupHttpMocks = require("../../utils/setup-http-mocks");
-const { getDefaultsForOldJsonSchema, getDefaultsForOAS2 } = require("../../../lib/bundle/defaults");
+const { getDefaultsForOldJsonSchema, getDefaultsForOAS2, getDefaultsForOAS3 } = require("../../../lib/bundle/defaults");
 
 describe("Custom bundling roots", () => {
  it("mixed inline", async () => {
@@ -420,4 +420,107 @@ describe("Custom bundling roots", () => {
  }
  });
  });
+
+ describe("OAS3 defaults", () => {
+ it("should not touch any other shared component different than schema", async () => {
+ setupHttpMocks({
+ "http://localhost:8080/test/Book.json": { name: "Book" },
+ "http://localhost:8080/test/Address.json": { title: "Address" },
+ "http://localhost:8080/test/Pets.json": { title: "Pets" },
+ });
+
+ let parser = new $RefParser();
+ const model = {
+ openapi: "3.0.0",
+ paths: {
+ "/pets": {
+ get: {
+ parameters: [
+ {
+ $ref: "http://localhost:8080/test/Book.json"
+ },
+ {
+ $ref: "http://localhost:8080/test/Book.json"
+ },
+ ],
+ responses: {
+ 200: {
+ content: {
+ "application/json": {
+ schema: {
+ $ref: "http://localhost:8080/test/Address.json",
+ }
+ },
+ "application/yaml": {
+ schema: {
+ $ref: "http://localhost:8080/test/Address.json",
+ }
+ }
+ }
+ },
+ 400: {
+ $ref: "http://localhost:8080/test/Pets.json",
+ },
+ 500: {
+ $ref: "http://localhost:8080/test/Pets.json",
+ },
+ }
+ }
+ },
+ },
+ };
+
+ const schema = await parser.bundle(model, {
+ bundle: getDefaultsForOAS3(),
+ });
+
+ expect(schema).to.equal(parser.schema);
+ expect(schema).to.deep.equal({
+ openapi: "3.0.0",
+ paths: {
+ "/pets": {
+ get: {
+ parameters: [
+ {
+ name: "Book"
+ },
+ {
+ $ref: "#/paths/~1pets/get/parameters/0"
+ }
+ ],
+ responses: {
+ 200: {
+ content: {
+ "application/json": {
+ schema: {
+ $ref: "#/components/schemas/Address"
+ }
+ },
+ "application/yaml": {
+ schema: {
+ $ref: "#/components/schemas/Address"
+ }
+ }
+ }
+ },
+ 400: {
+ title: "Pets"
+ },
+ 500: {
+ $ref: "#/paths/~1pets/get/responses/400"
+ }
+ }
+ }
+ },
+ },
+ components: {
+ schemas: {
+ Address: {
+ title: "Address"
+ }
+ },
+ }
+ });
+ });
+ });
 });