ahmedbilal · May 17, 2023 09:05 · May 17, 2023 · Aug 22, 2012 · Aug 22, 2012
diff --git a/API.md b/API.md
@@ -1,56 +1,55 @@
-**Title**
-----
-  <_Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple)._>
+# Title
 
-* **URL**
+<_Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple)._>
 
-  <_The URL Structure (path only, no root url)_>
+## Method & URL
 
-* **Method:**
-
-  <_The request type_>
+`GET` | `POST` | `DELETE` | `PUT` <_The URL Structure (path only, no root url)_>
 
-  `GET` | `POST` | `DELETE` | `PUT`
-
-*  **URL Params**
+<_For Example: `POST` /api/search/fastsearch/_>
 
-   <_If URL params exist, specify them in accordance with name mentioned in URL section. Separate into optional and required. Document data constraints._> 
+## URL Params
 
-   **Required:**
-
-   `id=[integer]`
+<_If URL params exist, specify them in accordance with name mentioned in URL section. Separate into optional and required. Document data constraints._> 
 
-   **Optional:**
-
-   `photo_id=[alphanumeric]`
+- **Required:**
+    - `id=[integer]`
 
-* **Data Params**
+- **Optional:**
+    - `photo_id=[alphanumeric]`
 
-  <_If making a post request, what should the body payload look like? URL Params rules apply here too._>
+## Data Params
 
-* **Success Response:**
-
-  <_What should the status code be on success and is there any returned data? This is useful when people need to to know what their callbacks should expect!_>
+<_If making a post request, what should the body payload look like? URL Params rules apply here too. Please format code correctly_>
 
-  * **Code:** 200 <br />
-    **Content:** `{ id : 12 }`
+## Success Response
+
+<_What should the status code be on success and is there any returned data? This is useful when people need to to know what their callbacks should expect!_>
+
+- **Status Code:** 200
+  ```json
+  {
+    "hello": "world"
+  }
+  ```
 
-* **Error Response:**
-
-  <_Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be liste d here. It might seem repetitive, but it helps prevent assumptions from being made where they should be._>
-
-  * **Code:** 401 UNAUTHORIZED <br />
-    **Content:** `{ error : "Log in" }`
+## Error Response
 
-  OR
+<_Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be liste d here. It might seem repetitive, but it helps prevent assumptions from being made where they should be._>
 
-  * **Code:** 422 UNPROCESSABLE ENTRY <br />
-    **Content:** `{ error : "Email Invalid" }`
+- **Status Code:** 401 UNAUTHORIZED
+  ```json
+  { "error" : "Log in" }
+  ```
+- **Status Code:** 422 UNPROCESSABLE ENTRY
+  ```json
+  { "error" : "Email Invalid" }
+  ```
 
-* **Sample Call:**
+## Sample Calls
 
-  <_Just a sample call to your endpoint in a runnable format ($.ajax call or a curl request) - this makes life easier and more predictable._> 
+  <_Sample calls to your endpoint> 
 
-* **Notes:**
+## Notes
 
   <_This is where all uncertainties, commentary, discussion etc. can go. I recommend timestamping and identifying oneself when leaving comments here._> 
diff --git a/EXAMPLE.md b/EXAMPLE.md
@@ -1,49 +0,0 @@
-**Show User**
-----
-  Returns json data about a single user.
-
-* **URL**
-
-  /users/:id
-
-* **Method:**
-
-  `GET`
-
-*  **URL Params**
-
-   **Required:**
-
-   `id=[integer]`
-
-* **Data Params**
-
-  None
-
-* **Success Response:**
-
-  * **Code:** 200 <br />
-    **Content:** `{ id : 12, name : "Michael Bloom" }`
-
-* **Error Response:**
-
-  * **Code:** 404 NOT FOUND <br />
-    **Content:** `{ error : "User doesn't exist" }`
-
-  OR
-
-  * **Code:** 401 UNAUTHORIZED <br />
-    **Content:** `{ error : "You are unauthorized to make this request." }`
-
-* **Sample Call:**
-
-  ```javascript
-    $.ajax({
-      url: "/users/1",
-      dataType: "json",
-      type : "GET",
-      success : function(r) {
-        console.log(r);
-      }
-    });
-  ```

diff --git a/API.md b/API.md
@@ -1 +1,56 @@
-| title | _Name of your API Call_ |
+**Title**
+----
+  <_Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple)._>
+
+* **URL**
+
+  <_The URL Structure (path only, no root url)_>
+
+* **Method:**
+
+  <_The request type_>
+
+  `GET` | `POST` | `DELETE` | `PUT`
+
+*  **URL Params**
+
+   <_If URL params exist, specify them in accordance with name mentioned in URL section. Separate into optional and required. Document data constraints._> 
+
+   **Required:**
+
+   `id=[integer]`
+
+   **Optional:**
+
+   `photo_id=[alphanumeric]`
+
+* **Data Params**
+
+  <_If making a post request, what should the body payload look like? URL Params rules apply here too._>
+
+* **Success Response:**
+
+  <_What should the status code be on success and is there any returned data? This is useful when people need to to know what their callbacks should expect!_>
+
+  * **Code:** 200 <br />
+    **Content:** `{ id : 12 }`
+
+* **Error Response:**
+
+  <_Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be liste d here. It might seem repetitive, but it helps prevent assumptions from being made where they should be._>
+
+  * **Code:** 401 UNAUTHORIZED <br />
+    **Content:** `{ error : "Log in" }`
+
+  OR
+
+  * **Code:** 422 UNPROCESSABLE ENTRY <br />
+    **Content:** `{ error : "Email Invalid" }`
+
+* **Sample Call:**
+
+  <_Just a sample call to your endpoint in a runnable format ($.ajax call or a curl request) - this makes life easier and more predictable._> 
+
+* **Notes:**
+
+  <_This is where all uncertainties, commentary, discussion etc. can go. I recommend timestamping and identifying oneself when leaving comments here._> 
diff --git a/EXAMPLE.md b/EXAMPLE.md
@@ -0,0 +1,49 @@
+**Show User**
+----
+  Returns json data about a single user.
+
+* **URL**
+
+  /users/:id
+
+* **Method:**
+
+  `GET`
+
+*  **URL Params**
+
+   **Required:**
+
+   `id=[integer]`
+
+* **Data Params**
+
+  None
+
+* **Success Response:**
+
+  * **Code:** 200 <br />
+    **Content:** `{ id : 12, name : "Michael Bloom" }`
+
+* **Error Response:**
+
+  * **Code:** 404 NOT FOUND <br />
+    **Content:** `{ error : "User doesn't exist" }`
+
+  OR
+
+  * **Code:** 401 UNAUTHORIZED <br />
+    **Content:** `{ error : "You are unauthorized to make this request." }`
+
+* **Sample Call:**
+
+  ```javascript
+    $.ajax({
+      url: "/users/1",
+      dataType: "json",
+      type : "GET",
+      success : function(r) {
+        console.log(r);
+      }
+    });
+  ```
diff --git a/API.md b/API.md
@@ -0,0 +1 @@
+| title | _Name of your API Call_ |