Feedback

OPENAPI_EG_DOCS.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.4
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        "200": # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string

README.md

@@ -1,5 +1,6 @@
+[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/QUdQy4ix)
 # CS3219 Project (PeerPrep) - AY2526S1
-## Group: Gxx
+## Group: G04
 
 ### Note: 
 - You are required to develop individual microservices within separate folders within this repository.

backend/README.md

@@ -0,0 +1,31 @@
+### Current structure of backend
+```
+backend/
+├── docs/
+├── services/
+│   ├── collaboration_service/
+│   │   └── src/
+│   │       └── README.md
+│   │   ├── docs/
+│   │       ├── api/
+│   │       ├── diagrams/
+│   ├── matching_service/
+│   │   └── src/
+│   │       └── README.md
+│   │   ├── docs/
+│   │       ├── api/
+│   │       ├── diagrams/
+│   ├── question_service/
+│   │   └── src/
+│   │       └── README.md
+│   │   ├── docs/
+│   │       ├── api/
+│   │       ├── diagrams/
+│   └── user_service/
+│   │   └── src/
+│   │       └── README.md
+│   │   ├── docs/
+│   │       ├── api/
+│   │       ├── diagrams/
+└── README.md
+```

backend/services/collaboration_service/README.md

@@ -0,0 +1 @@
+### README for collaboration service

backend/services/collaboration_service/docs/api/OPENAPI_EG_DOCS.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.4
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        "200": # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string

backend/services/matching_service/README.md

@@ -0,0 +1 @@
+### README for matching service

backend/services/matching_service/docs/api/OPENAPI_EG_DOCS.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.4
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        "200": # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string

backend/services/question_service/README.md

@@ -0,0 +1 @@
+### README for question service

backend/services/question_service/docs/api/OPENAPI_EG_DOCS.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.4
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        "200": # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string

backend/services/user_service/README.md

@@ -0,0 +1 @@
+### README for user service

backend/services/user_service/docs/api/OPENAPI_EG_DOCS.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.4
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+
+paths:
+  /users:
+    get:
+      summary: Returns a list of users.
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        "200": # status code
+          description: A JSON array of user names
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string

frontend/README.md

@@ -0,0 +1,2 @@
+### The frontend folder structure can be auto generated via nextjs build
+