diff --git a/packages/backend/src/modules/collection/README.md b/packages/backend/src/modules/collection/README.md index 1c1b000..7b3b97c 100644 --- a/packages/backend/src/modules/collection/README.md +++ b/packages/backend/src/modules/collection/README.md @@ -4,14 +4,27 @@ { "id":"String", - "user_id":"String", - "date_time":"Date", - "url":"String" + "title":"String", * + "questions_id":["String"], * + "exams_id":["String"], * + "owner_id":"String", * + "shared_with": ["String"], * + "created_at":"Date", * + "updated_at":"Date", * + "superior_collection": "Collection", * + "inferior_collections": "Collection", * + "url":"String" *? } ``` ### Method -- Record browsing history -- Clear browsing history \ No newline at end of file +- Create Collection * +- Update Collection * +- Delete Collection * +- Share Collection * +- Import Collection * +- Export Collection * +- Add Search to Collection * + diff --git a/packages/backend/src/modules/exam/README.md b/packages/backend/src/modules/exam/README.md index b6f659f..99e837e 100644 --- a/packages/backend/src/modules/exam/README.md +++ b/packages/backend/src/modules/exam/README.md @@ -5,7 +5,7 @@ { "id":"String", "title":"String", - "header": {"logo" : "Image", + "header": {"logo" : "String", "institution": "String", "department": "String", "grade": "String", @@ -19,14 +19,15 @@ "location": "String" }, "candidate": {"name": "String", - "registration_number": "String", - "signature": "String"}, + "registration_number": "String", + "signature": "String"}, "instructions": "String", - "value":"Number", + "maximum_mark":"Number", "owner_id":"String", "timeout_to_completion":{ + "duration":"Time", "start_time":"Time", - "end_time":"Time", + "end_time": "Time", "start_date":"Date", "end_date":"Date" }, diff --git a/packages/backend/src/modules/marker/README.md b/packages/backend/src/modules/marker/README.md index 554923b..bdd00d0 100644 --- a/packages/backend/src/modules/marker/README.md +++ b/packages/backend/src/modules/marker/README.md @@ -8,19 +8,24 @@ "color":"String", "owner_id":"String", "questions_id":["String"], - "urls":["String"], + "urls":["String"], *? "exams_id":["String"], "created_at":"Date", "updated_at":"Date", + "shared_with": ["String"], * + "superior_markers": "Marker", * + "inferior_markers": "Marker" * } ``` - ### Methods -- Add question to marker -- Add url to marker -- Add exam to marker -- Remove question from marker -- Remove url from marker -- Remove exam from marker \ No newline at end of file +- Create Marker * +- Update Marker * +- Delete Marker * +- Share Marker * +- Import Marker * +- Export Marker * +- Add question to marker * +- Add exam to marker * +- Add url to marker *? diff --git a/packages/backend/src/modules/question/README.md b/packages/backend/src/modules/question/README.md index 2857b57..d50459d 100644 --- a/packages/backend/src/modules/question/README.md +++ b/packages/backend/src/modules/question/README.md @@ -10,6 +10,7 @@ "is_public":"Boolean", "comments_id":["String"], "tags": ["String"], + "keywords": ["string"], "alternatives":[ { "id":"String", @@ -21,9 +22,9 @@ "position_fixed": "Boolean" } ], - "archived": "Boolean", "created_at":"Date", "updated_at":"Date", + "archived": "Boolean" } ```