From 1b83cd5eaa2b12947761e9b9e110da717fdf0174 Mon Sep 17 00:00:00 2001
From: Arlo <arlofilley@gmail.com>
Date: Fri, 22 Mar 2024 23:55:10 +0000
Subject: [PATCH] Add create_test

---
 create_test.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 create_test.md

diff --git a/create_test.md b/create_test.md
new file mode 100644
index 0000000..0b86c72
--- /dev/null
+++ b/create_test.md
@@ -0,0 +1,51 @@
+# Post Test Data  
+This API endpoint allows you to post test data, recording the results of a test taken by a user.  
+
+## POST `/api/post_test`
+
+## Request Parameters  
+| Parameter  |  Type   | Description                                          |
+| ---------- | :-----: | ---------------------------------------------------- |
+| testType   | String  | Type of the test (e.g., "typing", "multiple choice") |
+| testLength | Integer | Length of the test in number of items or questions   |
+| testTime   | Integer | Duration of the test in seconds                      |
+| testSeed   | String  | Seed for generating randomized test content          |
+| quoteId    | String  | Identifier for a specific quote, if applicable       |
+| wpm        | Integer | Words per minute (typing speed)                      |
+| accuracy   | Integer | Accuracy of responses (e.g., percentage)             |
+| userId     | String  | Identifier of the user taking the test               |
+| secret     | String  | Secret key for authentication and authorization      |
+
+## Example Request
+
+```bash 
+curl -X POST "https://example.com/api/post_test" \
+	-H "Content-Type: application/json" \ 
+	-d '{   
+		"testType": "typing",   
+		"testLength": 100,   
+		"testTime": 600,   
+		"testSeed": "random_seed_123",   
+		"quoteId": "quote_456",   
+		"wpm": 65.5,   
+		"accuracy": 98.2,   
+		"userId": "user_789",   
+		"secret": "your_secret_key_here" 
+	}'
+```
+
+## Example Response
+
+Upon successful submission, you will receive a JSON response with the following structure:
+
+```json
+{
+	"status": "success",   
+	"message": "Test results successfully recorded",   
+	"testId": "test_123456789" 
+}
+```
+
+- `status`: Indicates the status of the request (either "success" or "error").
+- `message`: Describes the outcome of the request.
+- `testId`: Unique identifier assigned to the recorded test data.