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

Add JSON Schema validation for AEG and Proof JSON #323

Open
2 tasks
James-Oswald opened this issue Dec 16, 2023 · 0 comments · May be fixed by #413
Open
2 tasks

Add JSON Schema validation for AEG and Proof JSON #323

James-Oswald opened this issue Dec 16, 2023 · 0 comments · May be fixed by #413
Assignees
@RyanR712
Labels
API-Break Will break test results or backwards compatibility. Leftmost number in semantic versioning Enhancement New feature good first issue Good for newcomers
Milestone
PMH 2.0.0

Comments

@James-Oswald
Copy link
Member

JSON schema will allow us to ensure users only upload valid proof files and let them know what is wrong with their proof file if they upload an invalid one. If the compression issue #268 is done before this, compare to the schema only after uncompressing the content.

  • Create a JSON schema for AEG JSON files as well as proof JSON files.
  • Validate any uploaded proof or AEG JSON file against the schema.
  • if it is invalid, display a visible error message where the error is in the json.
  • See here for validator libraries.
@James-Oswald James-Oswald added Enhancement New feature good first issue Good for newcomers labels Dec 16, 2023
@James-Oswald James-Oswald added this to the PMH 2.0.0 milestone Dec 16, 2023
@RyanR712 RyanR712 added the API-Break Will break test results or backwards compatibility. Leftmost number in semantic versioning label Jan 3, 2024
@RyanR712 RyanR712 self-assigned this Apr 15, 2024
@RyanR712 RyanR712 linked a pull request Jul 27, 2024 that will close this issue
Scheming! Not the MIT Kind #413
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RyanR712 RyanR712

Labels
API-Break Will break test results or backwards compatibility. Leftmost number in semantic versioning Enhancement New feature good first issue Good for newcomers
Projects
None yet
Milestone
PMH 2.0.0
Development

Successfully merging a pull request may close this issue.

Scheming! Not the MIT Kind RAIRLab/Peirce-My-Heart
2 participants
@James-Oswald @RyanR712