adobe / adobe/jsonschema2md

Markdown file does not get generated when a reference is used

Open
#254 4 comments 3 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description

## 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 property.

## What did you expect to happen

The links in all generated documents should be valid.

## What happened

When the markdown files are generated, the `foo.md` file contains a link to `foo-properties-bar.md` which doesn't exist.

## Do you have example files:

I am attaching a zip with the schema files and the generated markdown files.

[test.zip](https://github.com/adobe/jsonschema2md/files/5357366/test.zip)

Contributor guide

Open the contributing guide

Research direction

Unpack the attached test.zip and inspect the schema files and generated foo.md. Start by tracing how the property reference to bar is turned into the foo-properties-bar.md link. Done means the referenced Markdown document is generated or the link is corrected so all links in the generated documents are valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.