Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown file does not get generated when a reference is used #254

Open
savasp opened this issue Oct 9, 2020 · 4 comments
Open

Markdown file does not get generated when a reference is used #254

savasp opened this issue Oct 9, 2020 · 4 comments
Labels

Comments

@savasp
Copy link

savasp commented Oct 9, 2020

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

@trieloff trieloff added the bug label Oct 10, 2020
@jeffpatton1971
Copy link

I believe that I'm getting something similar in that referenced schemas are not being output. I'm actually getting a message that states that the URL cannot be resolved, when I curl that URL the CLI can't find, it downloads as expected.

@trieloff
Copy link
Collaborator

jsonschema2md does not download referenced schema files. If you want a schema file to be included, download it and store it with the remaining schema files in the folder that jsonschema2md processes.

@jeffpatton1971
Copy link

jeffpatton1971 commented May 25, 2021 via email

@trieloff
Copy link
Collaborator

I'd take a PR that turns these errors into warnings, but I can't say how much work it would be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants