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

Describing the JSON structure. #3

Open
spydmobile opened this issue Oct 4, 2023 · 1 comment
Open

Describing the JSON structure. #3

spydmobile opened this issue Oct 4, 2023 · 1 comment
Assignees
Labels
question Further information is requested

Comments

@spydmobile
Copy link

spydmobile commented Oct 4, 2023

So my first thought is we should be using JSON Schema officially to describe the JSON structure.

for those not familiar:
https://json-schema.org/learn/getting-started-step-by-step

The rationale is that it will be far easier to implement these entities/structures if they are described in JSON schema vs plain JSON.

The work put into the scheme can then be later used programmatically to generate entities etc.

@jordan-evens, you may be doing this already, but if not I am asking if we should do it moving forward.

@spydmobile spydmobile added the question Further information is requested label Oct 4, 2023
@jordan-evens
Copy link
Collaborator

Yeah we definitely need formal specs for things and not just verbiage. I have the first stab at the schemas in the schemas subfolder, and the example folders were some basic code to play around with them to see if they make sense. The readme for the repo is basically the thought process and considerations that went into making the files in the schema folder.

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

No branches or pull requests

2 participants