searching

Author: levkk

README.md

@@ -20,3 +20,27 @@ export DATABASE_URL=postgres://postgres:[email protected]:5432/postgres
 ./manage.py migrate
 ./manage.py runserver
 ```
+
+## Usage
+
+### Adding a TODO item
+
+Using cURL, make a POST request to `/api/todo/` with the two required fields, description & due date:
+
+```bash
+curl \
+	--silent \
+	-X POST \
+	-d '{"description": "Make a New Year resolution list", "due_date": "2025-01-01"}' \
+	-H 'Content-Type: application/json' \
+	http://localhost:8000/api/todo/
+```
+
+### Searching for similar TODO items
+
+```bash
+curl \
+	--silent \
+	-H "Content-Type: application/json" \
+	'http://localhost:8000/api/todo/search/?q=resolution&limit=1' | jq ".[0].description"
+```

todo/views.py

@@ -20,6 +20,10 @@ def search(self, request):
         """
         query = request.query_params.get("q")
         completed = request.query_params.get("completed")
+        limit = request.query_params.get("limit")
+
+        if limit:
+            limit = int(limit)
 
         if completed:
             completed = completed.lower() == "true"
@@ -38,6 +42,9 @@ def search(self, request):
             if completed:
                 results = results.filter(completed=completed)
 
+            if limit:
+                results = results[:limit]
+
             # If you want to see the query that is executed, uncomment the following line.
             # print(results.query)