Create REST API

[ceolinwill]

Our REST API must follow the OpenAPI specs.

Auth

Preview Give feedback

1. Sign in
2. Sign up
3. Reset password

Accounts

Preview Give feedback

1. User: Create, read, edit, delete
2. Users can run CRUD operations on their own data only

Organizations

Preview Give feedback

1. School: Create, read, edit, delete
2. SchoolUser: Create, read, edit, delete

Content

Preview Give feedback

1. Course: Create, read, edit, delete
2. CourseUser: Create, read, edit, delete
3. Lesson: Create, read, edit, delete
4. LessonStep: Create, read, edit, delete
5. StepOption: Create, read, edit, delete
6. UserSelection: Create

[amos-kibet]

How about GraphQL, for flexibility of data fetching? I am happy to pick this up, whether REST or GraphQL.

[ceolinwill]

@amos-kibet At first, I’d prefer to focus on the REST API because some orgs that will use Zoonk need to adhere to the OpenAPI specs. In the future, if we require more flexibility (and there’s demand for it), we can consider adding a GraphQL API as well.

In case you’d like to contribute, I’d advice to split your work into small chunks. For example, create one PR for each endpoint. If so, I apologize in advance because I didn’t do a good job documenting things yet, so you might have a hard time. If you have any questions, please feel free to ask.

I’ve updated the issue description to list the main endpoints.

[amos-kibet]

Hey @wceolin, no worries. I'll start as soon as I have some free time, but I'm not blocking anyone else from picking this up before then.