[FEATURE] Feedback system

.gitignore

@@ -1,5 +1,5 @@
 /target
 *.db
 .env
-
+.idea/
 .vscode/settings.json

migrations/20240823213817_add_feedback.down.sql

@@ -0,0 +1,5 @@
+-- Add down migration script here
+
+DROP TABLE IF EXISTS mod_feedback;
+DROP INDEX IF EXISTS public.idx_mod_feedback_mod_version_id;
+DROP INDEX IF EXISTS public.idx_mod_feedback_reviewer_id;

migrations/20240823213817_add_feedback.up.sql

@@ -0,0 +1,24 @@
+-- Add up migration script here
+
+CREATE TABLE mod_feedback
+(
+    id SERIAL PRIMARY KEY NOT NULL,
+    mod_version_id INTEGER NOT NULL,
+    reviewer_id INTEGER NOT NULL,
+    positive BOOLEAN NOT NULL,
+    feedback TEXT COLLATE pg_catalog."default" NOT NULL DEFAULT 'No feedback provided.'::text,
+    decision BOOLEAN NOT NULL DEFAULT false,
+    CONSTRAINT mod_feedback_mod_id_reviewer_id_key UNIQUE (mod_version_id, reviewer_id),
+    CONSTRAINT mod_feedback_mod_version_id_fkey FOREIGN KEY (mod_version_id)
+        REFERENCES public.mod_versions (id)
+        ON DELETE CASCADE,
+    CONSTRAINT mod_feedback_reviewer_id_fkey FOREIGN KEY (reviewer_id)
+        REFERENCES public.developers (id)
+        ON DELETE CASCADE
+);
+
+CREATE INDEX idx_mod_feedback_mod_version_id
+    ON public.mod_feedback (mod_version_id);
+
+CREATE INDEX idx_mod_feedback_reviewer_id
+    ON public.mod_feedback (reviewer_id);

migrations/20240826202953_feedback_v2.down.sql

@@ -0,0 +1,7 @@
+-- Add down migration script here
+
+DROP TYPE feedback_type;
+
+ALTER TABLE mod_feedback
+    ADD COLUMN positive BOOLEAN NOT NULL,
+    DROP COLUMN type;

migrations/20240826202953_feedback_v2.up.sql

@@ -0,0 +1,8 @@
+-- Add up migration script here
+
+CREATE TYPE feedback_type AS ENUM
+    ('Positive', 'Negative', 'Suggestion', 'Note');
+
+ALTER TABLE mod_feedback
+    DROP COLUMN positive,
+    ADD COLUMN type feedback_type NOT NULL;

openapi.yml

@@ -465,7 +465,7 @@ paths:
       tags:
         - mods
       summary: Add a developer to a mod
-      description: This endpoint is only used for adding a developer to a mod. Must be the owner the mod to access this endpoint.
+      description: This endpoint is only used for adding a developer to a mod. Must be the owner of the mod to access this endpoint.
       security:
         - bearerAuth: []
 
@@ -628,6 +628,70 @@ paths:
         "500":
           $ref: "#/components/responses/InternalServerError"
 
+  /v1/mods/{id}/versions/{version}/feedback:
+    get:
+      tags:
+        - mods
+      summary: Get feedback for a specific version of a mod
+      security:
+        - bearerAuth: []
+      parameters:
+        - $ref: "#/components/parameters/ModID"
+        - $ref: "#/components/parameters/ModVersion"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                  $ref: "#/components/schemas/ModFeedback"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+
+    post:
+      tags:
+        - mods
+      summary: Add feedback for a specific version of a mod
+      security:
+        - bearerAuth: []
+      parameters:
+        - $ref: "#/components/parameters/ModID"
+        - $ref: "#/components/parameters/ModVersion"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                feedback_type:
+                  type: string
+                  enum:
+                    - Positive
+                    - Negative
+                    - Suggestion
+                    - Note
+                  description: Type of feedback - positive/negative modifies score, note is mod dev only
+                  example: Positive
+                feedback:
+                  type: string
+                  description: The feedback given by the reviewer
+                  example: "This mod is great!"
+      responses:
+        "204":
+          description: No Content (Feedback added)
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+
 components:
   securitySchemes:
     bearerAuth:
@@ -973,6 +1037,56 @@ components:
         - android32
         - android64
         - ios
+
+    Reviewer:
+      type: object
+      properties:
+        id:
+          type: integer
+          description: The developer ID of the reviewer
+        display_name:
+          type: string
+          description: The display name of the reviewer
+        admin:
+          type: boolean
+          description: Whether the reviewer is an admin
+
+    ModFeedbackOne:
+      type: object
+      properties:
+        reviewer:
+          $ref: "#/components/schemas/Reviewer"
+          description: The reviewer that gave the feedback
+        feedback_type:
+          type: string
+          enum:
+            - Positive
+            - Negative
+            - Suggestion
+            - Note
+          description: Type of feedback - positive/negative modifies score, note is mod dev only
+        feedback:
+          type: string
+          description: The feedback given by the reviewer
+        decision:
+          type: boolean
+          description: Whether or not this feedback was used to make a decision
+
+    ModFeedback:
+      type: object
+      properties:
+        score:
+          type: integer
+          description: The score of the mod, calculated as a sum of all feedback where positive is 1 and negative is -1
+        mod_id:
+          $ref: "#/components/schemas/ModID"
+        mod_version:
+          $ref: "#/components/schemas/ModVersionString"
+        feedback:
+          type: array
+          items:
+              $ref: "#/components/schemas/ModFeedbackOne"
+
   parameters:
     ModID:
       name: id
@@ -1079,4 +1193,4 @@ components:
               error:
                 type: string
               payload:
-                type: "null"
+                type: "null"

src/endpoints/mod.rs

@@ -4,3 +4,4 @@ pub mod mod_versions;
 pub mod mods;
 pub mod tags;
 pub mod stats;
+pub(crate) mod mod_feedback;