Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

$ref only works on first level, broken on nested objects

See original GitHub issue

What did you do

I tried to generate markdown files for schemas:

./schemas/core.schema.json

{
  "$id": "https://example.org/core.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "foo": {
      "type": "object",
      "properties": {
        "bar": {
          "$ref": "https://example.org/extension.json#"
        }
      }
    },
    "profiling": {
      "$ref": "https://example.org/extension.json#"
    }
  },
  "required": [],
  "additionalProperties": false
}

./schemas/extension.schema.json

{
  "$id": "https://example.org/extension.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Baz",
  "type": "string",
  "enum": ["foo", "bar"]
}

using jsonschema2md -d ./schemas -o ./generated/schemas.

What did you expect to happen

I expect references to generate the appropriate links.

What happened

Apparently, only ref for profiling was resolved. For foo.bar that did not work:

# Schema

https://example.org/core.json

| Abstract            | Extensible | Status       | Identifiable | Custom Properties | Additional Properties | Defined In                           |
| ------------------- | ---------- | ------------ | ------------ | ----------------- | --------------------- | ------------------------------------ |
| Can be instantiated | No         | Experimental | No           | Forbidden         | Forbidden             | [core.schema.json](core.schema.json) |

## Schema Hierarchy

- `https://example.org/core.json`
- [Baz](extension.schema.md) `https://example.org/extension.json`

# Properties

| Property                | Type     | Required | Nullable | Defined by    |
| ----------------------- | -------- | -------- | -------- | ------------- |
| [foo](#foo)             | `object` | Optional | No       | (this schema) |
| [profiling](#profiling) | Baz      | Optional | No       | (this schema) |

## foo

`foo`

- is optional
- type: `object`
- defined in this schema

### foo Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| `bar`    |      | Optional |

#### bar

`bar`

- is optional
- type: reference

##### bar Type

<!--
####
The following link is broken
####
-->
- []() – `https://example.org/extension.json#`

## profiling

`profiling`

- is optional
- type: Baz
- defined in this schema

### profiling Type

<!--
####
But this one works!
####
-->
- [Baz](extension.schema.md) – `https://example.org/extension.json#`