Add hint scheme for tasks

materialsproject · Dec 11, 2021 · 4862fab · 4862fab
1 parent d6e5cde
commit 4862fab
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/mp_api/routes/tasks/hint_scheme.py b/src/mp_api/routes/tasks/hint_scheme.py
@@ -0,0 +1,16 @@
+from maggma.api.resource import HintScheme
+
+
+class TasksHintScheme(HintScheme):
+    """
+    Hint scheme for the tasks endpoint.
+    """
+
+    def generate_hints(self, query):
+
+        hints = {"hint": {}}
+
+        if query["criteria"] == {}:
+            hints["hint"]["_id"] = 1
+
+        return hints