Merge pull request #185 from Capstone-Projects-2024-Spring/update-doc…

…umentation

documentation/static/Synesthesia-Reading-App-1.0.0-resolved.yaml

@@ -88,21 +88,27 @@ paths:
         "201":
           description: Created
 
-  /feedback/:
-    post:
+  /http://127.0.0.1:5000/:
+    get:
       tags:
-        - feedback
-      summary: post a user feedback message
-      operationId: feedback_add
+        - coloring flask
+      summary: A call from the Laravel backend to the coloring flask to color a document
+      operationId: color_document
       requestBody:
+        required: true
+        description: contains a color profile and document text
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Feedback_Message'
-      responses:
-        "201":
-          description: Created
+              $ref: '#/components/schemas/Colored_Document_Request'
 
+      responses:
+        "200":
+          description: a Colored_Document object
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Colored_Document'
 components:
   schemas:
     Document:
@@ -116,19 +122,8 @@ components:
           example: The Silmarillion
         text:
           type: string
-        notes:
-          type: array
-          items:
-            $ref: '#/components/schemas/Note'
-    Note:
-      type: object
-      properties:
-        id:
-          type: string
-        location:
-          type: string
-        text:
-          type: string
+
+
     Color_Profile:
       description: Contains a map of graphemes to their associated colors and a map of words that are exceptions to the coloring rules to their colors
       type: object
@@ -138,7 +133,7 @@ components:
         exceptions-color map:
           $ref: '#/components/schemas/Word_Color_Map'
 
-    Colored_Page:
+    Colored_Document:
       description: contains the information necessary to render a colored page-- the tokenized text of the page and a word-color map containing word-color pairs for each unique word component on the page
       type: object
       properties:
@@ -148,6 +143,16 @@ components:
         word-color map:
           $ref: '#/components/schemas/Word_Color_Map'
 
+    Colored_Document_Request:
+      description: a Color Profile and document text, sent by the Laravel backend to the coloring flask to color the text
+      type: object
+      properties:
+        color_profile:
+          $ref: '#/components/schemas/Color_Profile'
+        text:
+          type: string
+          example: "Nevertheless, the angelic being persevered."
+
     Grapheme_Color_Map:
       type: object
       description: map of graphemes to RGB colors
@@ -182,7 +187,3 @@ components:
           description: R, G, and B values
           example: [250, 0, 0]
 
-    Feedback_Message:
-        type: string
-        description: a feedback message from a user
-        example: 'X feature was really helpful for me, but not Y'