Skip to content

Commit

Permalink
Feature/12 add uml mermaid diagram (#15)
Browse files Browse the repository at this point in the history
* initial pass at something

* incorrect association

* chaser

* initial pass

* aligning the comments
  • Loading branch information
windoverwater authored May 1, 2023
1 parent de9d579 commit e7dc948
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/webapi-to-backend-ballot-UML.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

```mermaid
classDiagram
Choice *-- Selection
Ballot *-- Contest
Contest *-- Selection
Choice *-- Ticket
class Choice {
+String name
+String party
+Dict ticket
+String choice_type
}
class Selection {
+Int index
+String name
}
class Ticket {
+String name
+String party
}
class Contest {
+List choices # order is important
+String vote_variation # RCV, plurality
+String uid # unique to election only
+Float win_threshold # default = 0.5
+Int votes_allowed # defines overvote
+String write_in # unimplemented
+List selection # index + name
}
class Ballot {
+List active_ggos # order is important
+Dict contests # ordered by active_ggos
+String ballot_status # blank or cast
}
```

0 comments on commit e7dc948

Please sign in to comment.