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.

Sign up for GitHub

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

Jump to bottom

api: doc validate the correctness of current schema #20

Open
willfindlay opened this issue Dec 28, 2022 · 0 comments
Open

api: doc validate the correctness of current schema #20

willfindlay opened this issue Dec 28, 2022 · 0 comments
Labels
area/api Related to the API area/schema Related to the API schema area/testing Related to testing good first issue Good for newcomers

Comments

@willfindlay
Copy link
Owner

Our current schema (located in src/types.rs) is mostly derived from reading the aoe4world source and experimenting with the API to figure out what fields are supported. This is obviously error-prone, but there is currently no better way due to a lack of official documentation.

It would be nice to validate the correctness of the current schema, ideally by adding more tests that cover additional examples.
@willfindlay willfindlay added good first issue Good for newcomers area/api Related to the API area/schema Related to the API schema area/testing Related to testing labels Dec 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/api Related to the API area/schema Related to the API schema area/testing Related to testing good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@willfindlay