This project allows to convert a [JSON schema](https://json-schema.org) to native english text.
npm install explain-json-schemaThis project allows to convert a JSON schema to native english text.
Examples:
* Configuration osiota ArtNet app
* Configuration osiota Modbus app
* Basic attributes:
* enum, const
* deprecated
* $ref locally
* number, integer
* minimum, maximum, exclusiveMinimum, exclusiveMaximum
* multipleOf
* string
* minLength, maxLength
* format
* pattern
* contentMediaType
* contentEncoding
* boolean
* null
* object
* properties
* additionalProperties (as boolean and as object)
* patternProperties
* required
* minProperties, maxProperties
* propertyNames.pattern
* array
* items (schema)
* items (array of schemas)
* minItems, maxItems
* uniqueItems
* contains
* minContains, maxContains
* allOf, oneOf, anyOf, not
* if, then, else
* multiple types (type: ["string", "null"])
* object: dependencies (Properties and Schema)
``sh`
npm install explain-json-schema
Run:
`sh`
npx explain-json-schema --schema schema.json >TEXT.md
See cli.js`
This software is released under the MIT license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.