Support any Stoplight service

Author: P0lip

lib/bundle/stoplight/generator.js

@@ -14,8 +14,9 @@ function normalizeOpts (opts) {
  if (typeof opts.endpointUrl === "string") {
  opts.endpointUrl = KeyGenerator.appendSlash(opts.endpointUrl);
  }
- else {
- opts.endpointUrl = null;
+ else if (!(opts.endpointUrl instanceof RegExp)) {
+ // {apiUrl}/api/v1/projects/{workspaceSlug}/{projectSlug}/nodes{+nodeUri}
+ opts.endpointUrl = /\/api\/v1\/projects\/[^/]+\/[^/+]+\/nodes\/(?!$)/;
  }
 
  return opts;
@@ -57,8 +58,10 @@ StoplightKeyGenerator.prototype.extractFilepathFromUrl = function (url) {
 
  let mid = query.mid ? `_m${query.mid}` : "";
 
- if (href.indexOf(endpointUrl) === 0) {
- return href.slice(endpointUrl.length) + mid;
+ let [, filepath] = href.split(endpointUrl);
+
+ if (filepath) {
+ return filepath + mid;
  }
 
  return url;

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

@@ -9,28 +9,39 @@ const createStoplightDefaults = require("../../../lib/bundle/stoplight/defaults"
 const cwd = typeof window === "object" ? location.origin + "/base/test/specs/custom-bundling-roots-new-stoplight" : __dirname;
 
 describe("Stoplight-specific defaults", () => {
- it("should recognize platform references", async () => {
- let defaults = createStoplightDefaults({
- cwd,
- endpointUrl: "http://jakub.stoplight-local.com:8080/api/v1/projects/jakub/my-project/nodes",
- });
+ let model;
 
+ beforeEach(() => {
  setupHttpMocks({
  "http://jakub.stoplight-local.com:8080/api/v1/projects/jakub/my-project/nodes/reference/Book.v1.json": {
  title: "Book"
  },
+ "http://marc.stoplight-local.com:8080/api/v1/projects/marc/my-project/nodes/models/Street.v1.json": {
+ title: "Book"
+ },
  });
 
- const model = {
+ model = {
  properties: {
  id: {
  type: "string"
  },
  book: {
  $ref: "http://jakub.stoplight-local.com:8080/api/v1/projects/jakub/my-project/nodes/reference/Book.v1.json"
  },
+ street: {
+ $ref: "http://marc.stoplight-local.com:8080/api/v1/projects/marc/my-project/nodes/models/Street.v1.json"
+ },
  }
  };
+ });
+
+
+ it("given explicit endpointUrl, should recognize platform references pointing at that entity", async () => {
+ let defaults = createStoplightDefaults({
+ cwd,
+ endpointUrl: "http://jakub.stoplight-local.com:8080/api/v1/projects/jakub/my-project/nodes",
+ });
 
  let parser = new $RefParser();
 
@@ -51,6 +62,44 @@ describe("Stoplight-specific defaults", () => {
  },
  id: {
  type: "string"
+ },
+ street: {
+ title: "Book"
+ }
+ }
+ });
+ });
+
+ it("given no explicit endpointUrl, should recognize platform references pointing at any Stoplight-compatible entity", async () => {
+ let defaults = createStoplightDefaults({
+ cwd,
+ });
+
+ let parser = new $RefParser();
+
+ const schema = await parser.bundle(__dirname, model, {
+ bundle: defaults.json_schema,
+ });
+
+ expect(schema).to.equal(parser.schema);
+ expect(schema).to.deep.equal({
+ definitions: {
+ "Book.v1": {
+ title: "Book"
+ },
+ "Street.v1": {
+ title: "Book"
+ }
+ },
+ properties: {
+ book: {
+ $ref: "#/definitions/Book.v1"
+ },
+ id: {
+ type: "string"
+ },
+ street: {
+ $ref: "#/definitions/Street.v1"
  }
  }
  });