$ npm i -g supermodel-cli
validate-schema <yamlSchemaFile> Validate JSON Schema YAML representation
Validates a JSON Schema in YAML format against meta schema including any referenced remote schemas ($ref).
Referenced remote schemas are resolved first from the local file system. The
parent directory of the <yamlSchemaFile> is used as the base path for
resolving referenced schemas.
$ ./bin/supermodel validate-schema ./fixtures/supermodel/User.yaml
loaded 'http://supermodel.io/supermodel/Layer' from 'fixtures/supermodel/Layer.yaml'
loaded 'http://supermodel.io/supermodel/Model' from 'fixtures/supermodel/Model.yaml'
loaded 'http://supermodel.io/supermodel/Team' from 'fixtures/supermodel/Team.yaml'
loaded 'http://supermodel.io/supermodel/Address' from 'fixtures/supermodel/Address.yaml'
ok.
compile-schema <yamlSchemaFile> Compile JSON Schema YAML representation, resolving every references
Compiles the target schema <yamlSchemaFile>, resolving its remote schema
references into one JSON Schema file in YAML format.
Note: Does not validates the target schema file.
$ ./bin/supermodel compile-schema ./fixtures/supermodel/Team.yaml > compiled.yaml
$ ./bin/supermodel validate-schema compiled.yaml
ok.
oas2 <yamlSchemaFile> Convert JSON Schema YAML representation to OpenAPI Specification 2.0 definitions. Doesn't resolve remote schema references.
Converts the target schema <yamlSchemaFile> into OpenAPI Specification 2.0 definitions.
The conversion drops unsupported properties by OAS2. It also "flattens" all definitions, since in OAS2 you can't have nested definitions. Finally all remote schema references using relative identifiers are fully quantified.
$ ./bin/supermodel compile-schema ./fixtures/supermodel/Team.yaml > compiled.yaml
$ ./bin/supermodel oas2 ./compiled.yaml