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

Potential issue with JSON schema output #25

Open
paulyoung opened this issue Aug 11, 2015 · 3 comments
Open

Potential issue with JSON schema output #25

paulyoung opened this issue Aug 11, 2015 · 3 comments

Comments

@paulyoung
Copy link
Contributor

I see some JSON schema information displayed like this:

screen shot 2015-08-11 at 3 17 37 pm

In particular, I'm not sure if the "$ref": "base.json#/definitions/uuid" part is supposed to be displayed that way or if something has gone wrong with page rendering.

If it is correct, could someone point me to where base.json lives?

@jonnor
Copy link
Contributor

jonnor commented Aug 15, 2015

@paulyoung base.json should be built from base.yaml (like all the .json files) https://github.com/the-grid/apidocs/blob/master/schemata/base.yaml

What do you think is wrong here?

@jonnor jonnor removed the bug label Aug 15, 2015
@paulyoung
Copy link
Contributor Author

It's not intuitive for me as someone reading the documentation what "$ref": "base.json#/definitions/uuid" means or where base.json can be found for me to view.

I thought maybe the intention was for the UUID section of base.json to be rendered inline here and perhaps something had gone wrong with that.

@hannesstruss
Copy link

It definitely would be helpful if the ref was clickable.

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

No branches or pull requests

3 participants