Merge pull request #1875 from dandi/add-help-text-query-params

Improve Swagger documentation for /dandisets/ query params

dandiapi/api/views/serializers.py

@@ -178,10 +178,20 @@ class Meta(DandisetSerializer.Meta):
 
 
 class DandisetQueryParameterSerializer(serializers.Serializer):
-    draft = serializers.BooleanField(default=True)
-    empty = serializers.BooleanField(default=True)
-    embargoed = serializers.BooleanField(default=False)
-    user = serializers.CharField(required=False)
+    draft = serializers.BooleanField(
+        default=True,
+        help_text='Whether to include dandisets that only have draft '
+        "versions (i.e., haven't been published yet).",
+    )
+    empty = serializers.BooleanField(default=True, help_text='Whether to include empty dandisets.')
+    embargoed = serializers.BooleanField(
+        default=False, help_text='Whether to include embargoed dandisets.'
+    )
+    user = serializers.ChoiceField(
+        choices=['me'],
+        required=False,
+        help_text='Set this value to "me" to only return dandisets owned by the current user.',
+    )
 
 
 class DandisetSearchQueryParameterSerializer(DandisetQueryParameterSerializer):