Update README.md

turingschool · Sep 9, 2024 · a1ec7cf · a1ec7cf
1 parent fcfaa5f
commit a1ec7cf
Showing 1 changed file with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -431,22 +431,22 @@ This is the backend API repository for TurLink. TurLink is a link shortener app
       ]
     }
     ```
-    ### Get Summary for a Link
-    - **GET** `/api/v1/summary?link={original link}`
-      - Description: Retrieves a summary of the content at the given link.
-      - Example Request: GET `https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/summary?link=www.example.com`
-      - Successful Response (200 OK):
-        ```json
-        {
-          "data": {
-            "attributes": {
-              "link": "www.example.com",
-              "summary": "1. example 1\n2. example 2\n3. example 3"
-            }
-          }
+### Get Summary for a Link
+- **GET** `/api/v1/summary?link={original link}`
+  - Description: Retrieves a summary of the content at the given link.
+  - Example Request: GET `https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/summary?link=www.example.com`
+  - Successful Response (200 OK):
+    ```json
+    {
+      "data": {
+        "attributes": {
+          "link": "www.example.com",
+          "summary": "1. example 1\n2. example 2\n3. example 3"
         }
-        ```
-      - Notes:
-        - This endpoint currently returns mock data.
-        - In the future, it will provide an actual summary of the content at the given link.
-        - The summary is expected to be a string with numbered points, separated by newline characters.
+      }
+    }
+    ```
+  - Notes:
+    - This endpoint currently returns mock data.
+    - In the future, it will provide an actual summary of the content at the given link.
+    - The summary is expected to be a string with numbered points, separated by newline characters.