add back end routes #135
add back end routes #135
Conversation
| description: This is backend api for edugator https://github.com/edugator-cise/edugator-staff-backend | ||
| contact: | ||
| email: [email protected] | ||
| license: |
There was a problem hiding this comment.
update to:
license:
name: GNU v0.3
url: https://www.gnu.org/licenses/gpl-3.0.en.html
version: 2.0.0
| url: http://swagger.io | ||
| servers: | ||
| - url: https://edugator-admin.com/v2 | ||
| - url: https://edugator-admin.com/v2 |
There was a problem hiding this comment.
why are there two server urls?
| schema: | ||
| type: object | ||
| properties: | ||
| exp: |
| - submissionId | ||
| - submissionType | ||
| - timeOfSubmission | ||
| - score |
There was a problem hiding this comment.
I think the schema should also contain the submission itself in the form of an object. For example, if a student submits code, the actual code as well as the feedback generated at the time of submission.
| post: | ||
| tags: | ||
| - submission | ||
| summary: creates a submission |
There was a problem hiding this comment.
we also need a delete for the submission. There will be a delete course option that deletes all submissions or the user can delete their data.
| post: | ||
| tags: | ||
| - user | ||
| summary: adds a course to a user |
There was a problem hiding this comment.
change summary to "adds a user to a course".
| SubmissionEvent: | ||
| required: | ||
| - userId | ||
| - courseId |
There was a problem hiding this comment.
this course id should be problem/lesson id as an event is associated with a problem/lesson rather than a course.
| score: | ||
| type: integer | ||
| ProblemWithoutId: | ||
| required: |
There was a problem hiding this comment.
I think each problem will have a link ID (url) for mapping it to Canvas. this should be optional but can be added to the schema
| get: | ||
| tags: | ||
| - problem | ||
| summary: Gets all the non hidden problems for COP3530 course given module id |
There was a problem hiding this comment.
clean all cop3530 to "a course"; repeat for all summaries.
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/Problem' | ||
| /problem: |
There was a problem hiding this comment.
should we rename the problem routes to something else - as we have two types now: lessons vs coding problems. Or there should be some means to distinguish the two
This PR adds in the back end routes for edugator v2 series with multi class integration. This is written in OpenAPI 3.1
For seeing the UI configuration, go to https://editor.swagger.io/ and import said yaml file
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):