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

Update schema.json and README #181

Open
steven11sjf opened this issue Mar 13, 2024 · 0 comments
Open

Update schema.json and README #181

steven11sjf opened this issue Mar 13, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@steven11sjf
Copy link

The README currently says

The API/Schema for the input json file will soon be documented.

Cross-referencing the schema.json and SeedObject it seems like the schema partially documents it but is missing some fields (at first glance, starting_items and pickups are missing documentation and pipes is not a field). This should be updated to be consistent, and the README should direct users to schema.json.

It looks like you could auto-generate a schema.json based on the SeedObject, based on this StackOverflow post. I'd also look into adding CI to ensure schema matches and see if there's a way to add property attributes for schema fields like description.

@Miepee Miepee added the enhancement New feature or request label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants