feat: random entry (#113)

* feat: random entry

* docs+feat: api random route

* style: random is now inside the search

* docs: random query is now documented

* fix: page current now returns an integer number

* Update API.md

---------

Co-authored-by: Antonio Vivace <[email protected]>

Author: dag7dev

API.md

@@ -76,12 +76,12 @@ Returns every entry in the database. Every entry is represented by its game mani
 Return every entry in the database matching the given conditions. Every entry is represented by its game manifest.
 
 The following query parameters can be used:
-
 - `type` (exact matching)
 - `developer` (exact matching)
 - `platform` (exact matching)
 - `tags` (exact matching, comma-separated array e.g. `/search?tags=Open Source,RPG`)
 - `title` ("contains" matching, e.g. `/search?title=brick` will return "**Brick**ster" and "**Brick**Breaker")
+- `random` (if true, the results will be in a random order)
 
 More than one query parameter can be specified. They will be concatenated in "AND" statements, i.e. `/search?type=homebrew&platform=GBC` will return every Homebrew developed with GBC features.
 
@@ -94,6 +94,11 @@ Every matching is case-insensitive.
 curl hh3.gbdev.io/api/search?tags=Open Source,RPG&platform=GBC
 ```
 
+```bash
+# Get Game Boy Color games in a random order
+curl hh3.gbdev.io/api/search?random=true&platform=GBC
+```
+
 ### Pagination
 
 Every result is paginated. These additional query params can be used in any of the previous routes:

hhub/views.py

@@ -77,7 +77,6 @@ def entries_all(request):
     )
     return JsonResponse(serializer.data, safe=False)
 
-
 def search_entries(request):
     """
     Returns every entry matching the conditions given in the query
@@ -93,6 +92,7 @@ def search_entries(request):
     tags = request.GET.get("tags", "")
     platform = request.GET.get("platform", "")
     text_query = request.GET.get("q", "")
+    random_query = request.GET.get("random", False)
 
     # Pagination
     # Request a specific page
@@ -139,6 +139,9 @@ def search_entries(request):
         )
     results = len(entries)
 
+    if random_query:
+        entries = entries.order_by("?")
+
     # Prepare paginators and number of results
     paginator = Paginator(entries, num_elements)
 
@@ -171,7 +174,7 @@ def search_entries(request):
             # total number of pages
             "page_total": paginator.num_pages,
             # current request page
-            "page_current": page,
+            "page_current": int(page),
             # number of elements in this page
             "page_elements": len(serializer.data),
             # array of entries manifests