jsonschema2md icon indicating copy to clipboard operation
jsonschema2md copied to clipboard

$ref to other files

Open ajoga opened this issue 1 year ago • 1 comments

As I have multiple object loosely related to each other that are referencing common definitions, I'm exploring using $ref and referencing another file.

I'm getting weird outputs from jsonschema2md2, could this usage not be supported?

I've tried to render the schemas from this tutorial ; I named the files entry-schema.json and fstab.json. Rendered fstab.md yields:

# JSON Schema

## Pattern Properties

- **`^(/[^/]+)+$`**: Refer to *[https://example.com/entry-schema](#tps://example.com/entry-schema)*.
## Properties

- **`/`**: Refer to *[https://example.com/entry-schema](#tps://example.com/entry-schema)*.

I have two questions:

  • Am I trying to be overkill referencing objects across files? Is this uncommon in practice?
  • If this is unsupported, what would it take to be supported?

ajoga avatar Aug 14 '23 17:08 ajoga