-
Notifications
You must be signed in to change notification settings - Fork 0
Completion Criteria
For this experiment to be a success, it must satisfy the criteria described in this document. The overarching goal is to 1) create a system for automatically generating an API server from JSON specifications and 2) implement a sample app on top of it with reasonably complex data structures.
(fill this in later)
The API we are creating as a sample use case is a scheduling application for multi-organization events such as conferences or tournaments. It contains three main data types: User, Organization, and Event.
This is the simplest structure with the simplest endpoints; it's also pretty self-explanatory. It represents a user with email, username, and password hash.
An organization is essentially a list of users-- its purpose here is to ensure that the generator can handle endpoints which reference multiple collections, such as /organization/:orgId/members.
An event is essentially a date and a list of organizations. Its purpose here is to ensure that the generator can handle complex queries, such as finding all events which take place within a specified time period.