References like

{
     "$ref": "http://example.org/other-schema.json
}

might be rendered correctly already. But it should be possible to provide an alternative link location to a static documentation of the target schema.

The "patternProperties"-property is not rendered at the moment. (see http://json-schema.org/example2.html for an example)

There should be a table of contents or a navigation-element on the left to get a better overview over the schema.

When generating documentation for a schema that contains a type defined with oneOf, there is no documentation generated for those possible items from the oneOf definition.

Given the following schema:

{
  "title": "Example json-schema: oneOf where the elements are references.",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "This schema has two properties: a type that is defined by 'oneOf', where the items within are references to other types.",
  "properties": {
    "oneOfWithReferences" : {
      "description": "Some type, that can be one of 2 different types, defined by a reference.",
      "oneOf": [
        { "$ref": "#/definitions/one" },
        { "$ref": "#/definitions/two" }
      ]
    },
    "oneOfInline" : {
      "description": "Some type, that can be one of 2 different types, defined in-line",
      "oneOf": [
        { "type": "string" },
        { "type": "number" }
      ]
    }
  },
  "definitions": {
    "one" : {
      "description": "Number one of the types that `oneOfWithReferences` is allowed to be",
      "type": "string" },
    "two" : {
      "description": "Number two of the types that `oneOfWithReferences` is allowed to be",
      "type": "number"
    }
  }
}

When running

$ bootprint json-schema filename-of-schema-above.json out
Loading bootprint-json-schema 1.1.0
Loading bootprint-base 1.1.0
[ 'out/index.html',
  'out/main.css',
  'out/main.css.map',
  'out/bundle.js',
  'out/bundle.js.map' ]

When opening index.html in a browser; I see the following:

Expected:

The types oneOfWithReferences and oneOfInline should have a list of possible subtypes. For oneOfInline you'd expect the sub-types to be rendered "in line" if possible. For oneOfWithReferences you'd expect a list of links to the allowed sub-types.

I have examples in my schema and would like them included in the output. Is this possible?

{
  "title": "Metadata",
  "description": "Metadata about a piece of media and its status in the system",
  "type": "object",
  "properties": {
    "name": {
      "description":
        "The human readable name of the media. This defaults to the name of the file on the user file system when it was uploaded.",
      "type": "string",
      "examples": ["some-awesome-file.txt", "rick-roll.mp4"]
    }
  }
}

What I did:

Attempted to use bootprint json-schema in "developer" (watch) mode.

Steps to repro:

Assuming you have a json file TEST.json:

• npm install -g bootprint bootprint-json-schema
• bootprint json-schema ./TEST.json output/ -d

What I expected to happen:

File watcher starts, files are generated.

What actually happens:

Crashes with TypeError: qfs.isDirectory is not a function within customise-watch.

More details

There seems to be a complex dependency tree here, but reproduction is trivial.

Full stack trace is:

BenMBP:bootprint-json-schema ben$ bootprint json-schema ../bootprint/examples/content.yaml tmp/ -d
Loading bootprint-json-schema 1.1.0
Loading bootprint-base 1.1.0
Serving "tmp/" at http://127.0.0.1:8181
Ready for changes
/Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/q/q.js:155
                throw e;
                ^

TypeError: qfs.isDirectory is not a function
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/customize-watch/lib/watcher.js:43:22
    at Array.map (<anonymous>)
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/customize-watch/lib/watcher.js:39:18
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/lodash/index.js:3073:15
    at baseForOwn (/Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/lodash/index.js:2046:14)
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/lodash/index.js:3043:18
    at Function.<anonymous> (/Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/lodash/index.js:3346:13)
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/customize-watch/lib/watcher.js:35:7
    at _fulfilled (/Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/q/q.js:854:54)
    at /Users/ben/.nvm/versions/node/v10.16.3/lib/node_modules/bootprint/node_modules/q/q.js:883:30
BenMBP:bootprint-json-schema ben$

This function was added in m-io v0.5.0 (nknapp/m-io@932d674) and while I tried to fix this with sufficient cloning of various bootprint repos, and editing various package.json files, I simply ran out of talent.

Most of the dependencies declare that they require m-io 0.3.1 but clearly customise-watch requires 0.5.0 however, the customize-watch that gets installed declares that it requires 0.3.1.

I've raised this here, rather than at bootprint/customize-watch because I found this issue here and it doesn't appear to happen in the bootprint tests (I checked this too).

Version 4.0.7 of handlebars just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As handlebars is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

here: https://github.com/bootprint/bootprint-json-schema/blob/master/handlebars/partials/json-schema/datatype.hbs#L62 missprint:

maxlength instead maxLength

If a discriminator is an enum-property, the enum-values to link to #/definitions/{value} to allow better navigation in polymorphic structures.

Version 3.4.2 of mocha just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

It would make navigating across hierarchical trees of complex entities with sub-entities more convenient if it was possible to collapse/expand each nesting level - something akin to this: https://www.w3schools.com/jquerymobile/tryit.asp?filename=tryjqmob_collapsible