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

Pick a JSON Schema Visualizer and auto update website with schema and visualizer #84

Open
3 tasks
tgadam opened this issue Jul 29, 2022 · 9 comments
Open
3 tasks
Assignees
Labels
Type: Documentation New, fixed or enhanced documentation request.

Comments

@tgadam
Copy link
Contributor

tgadam commented Jul 29, 2022

Pick and implement a JSON Schema Visualizer, JSON Schema Documenter and auto update website with schema, documenation, and visualizer.

We want to auto generate the following on post on the fsml website from the https://github.com/TeselaGen/fsml.org/blob/main/packages/standard/fsml-schema.json file.

@tgadam tgadam added the Type: Documentation New, fixed or enhanced documentation request. label Jul 29, 2022
@eabeliuk
Copy link
Contributor

@tgadam to pair with @christopher-lamkin on this one asap.

@tgreen7
Copy link
Contributor

tgreen7 commented Aug 16, 2022

The wetzel one would not run. Looks like it might be windows only? I tried https://www.npmjs.com/package/material-ui-json-schema-viewer for a first pass. Seems like we can use react components pretty easily.

@juanneilson
Copy link
Member

Here's a very good one, not sure if one could automate visualizations:
https://jsonvisio.com

@eabeliuk
Copy link
Contributor

@juanneilson ..looks good.
@tgreen7 : could you use this tool to embed the graph on the fsml website?

@tgreen7
Copy link
Contributor

tgreen7 commented Aug 19, 2022

Pasting in our example schema it is too big for creating a link. Maybe it will be possible once we actually make our real schema which should be smaller.

@eabeliuk
Copy link
Contributor

not sure about what is it that you are testing, but what about using an URL shortener? (e.g.: https://tinyurl.com/ub2bn4th)

@eabeliuk
Copy link
Contributor

eabeliuk commented Sep 9, 2022

We liked the original schema viewer (https://jsoncrack.com, formerly jsonvisio), but it has some limitations in terms of the size of the schema that can be embedded, using their embedding link (with default parameters). The plan is to download the tool and run it in our own instance, and explore using an embeddable component for a standalone react app.

@eabeliuk
Copy link
Contributor

eabeliuk commented Sep 9, 2022

Next step is to do a simple custom component for docusource, that can be used within fsml.org.

@tgreen7
Copy link
Contributor

tgreen7 commented Sep 23, 2022

we want this to be solved AykutSarac/jsoncrack.com#149 then we could host our schema on a cdn and easily be able to open it. I think that is preferable to hosting our own docker instance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation New, fixed or enhanced documentation request.
Projects
None yet
Development

No branches or pull requests

5 participants