jsonschema2md
jsonschema2md copied to clipboard
adobe
Convert Complex JSON Schemas into Markdown Documentation
https://github.com/adobe/jsonschema2md/blob/2a0f6f8e9f0d3454dc330ba9eb2fef7ebdf50875/lib/formatInfo.js#L67 If your user has a dot in it like `j.doe` then it will cut it off at `j` and looks for the path with `j.description.md` at the end and...
### Expected Behaviour When defining a schema object (which is an extended subset of the JSON Schema Specification) in the context of a OpenAPI document, a few keywords might have...
## What did you do I have two simple schemas: `foo` and `bar`. `foo` references `bar` via a property called `bar`. There is a `$ref` in the declaration of that...
Currently the tool will process all json files, in some instances it could be super handy to provide the ability to skip a named file or pattern of files. Often...
## What did you do - Update jsonschema2md to v4.1.1 - ran conversion for single schema file ## What did you expect to happen Conversion to mark down without errors...
Is that a way to generate a README with only Top-level Schemas and without header (README)?
Hi all, I encountered an issue when trying to generate documentation from a set of schemas that contain a circular reference. ```json { "$id": "https://example.org/foo", "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties":...
The markup version of the readme that is displayed for the main page in this repo contains the following bad link: "please use GitLocalize" Status code [404:NotFound] - Link: https://gitlocalize.com/repo/3622...
## What did you do I got the following error: ``` UnhandledPromiseRejectionWarning: TypeError: Cannot convert object to primitive value at Object.get (XXX/node_modules/@adobe/jsonschema2md/lib/schemaProxy.js:140:50) ``` ## What did you expect to happen...
I tried to simplify the schema. There is probably a simpler version of the following schema to illustrate the problem. The following schema is valid. It declares a property named...