📝 Document JSON Schema

[keithrfung]

Feature Request

Create a JSON schema for each of the models in the electionguard-python repository. Use this mkdocs plugin to display the schema in documentation for easy consumption.

Tasks

• Create folder schema of JSON Schema

  • Election
    • Manifest
    • CiphertextElectionContext
    • ElectionConstants
    • EncryptionDevice
  • Ceremony
    • GuardianRecord
    • LagrangeCoefficientsRecord
  • Ballot
    • SubmittedBallot
    • CiphertextBallot
    • PlaintextBallot
  • Tally
    • PlaintextTally
    • CiphertextTally
    • PublishedCiphertextTally (Until adjustments made)

• Document

  • Under a Data Format section, add brief description and then link to pages for each of the previous schemas as individual pages with a brief description and using the mkdocs plugin to display schema file. It should target https://www.electionguard.vote/spec/Data_Format/

[keithrfung]

As a sidenote, these can be broken up into individual pull requests instead of tackling this as a full issue.

[manoloesparta]

Can you assign me this? I would like to help

[keithrfung]

@manoloesparta Sure. It's a pretty big issue. Try and take a chunk at a time.

[melkyy]

Ok I'm figure out how accomplish this, where I'd create the schema folder? inside of docs? or in the root of the project?

[keithrfung]

@melkyy We would absolutely love some help on this. Remember you don't have to do ALL of the schemas just any and getting started would be appreciated.

I would make a schema folder within the docs folder.

- docs / 
--- schema / 
------ example.schema.json

Each schema should be linked to from the Data Format page.
https://www.electionguard.vote/spec/Data_Format/

An example would be:

## Ballot

-  [SubmittedBallot](link_to_schema)
    A ballot that has been cast or spoiled/challenged. 

[melkyy]

@keithrfung
sorry for the late response, all within electionguard-python repository rigth? I've created example.schema.json in docs/schema

am I doing well?

[keithrfung]

@melkyy Yes. I believe this has to be within the docs folder to use the mkdocs plugin to view the schema. This looks great!

Don't forget to add this, so you can view the schemas in the site
https://github.com/galamdring/mkdocs-json-schema-plugin

[keithrfung]

@melkyy Any more help needed?