Updated docs for v2/observations/updates

inaturalist · Feb 2, 2024 · f58e3f4 · f58e3f4
1 parent 3e1f2e8
commit f58e3f4
Showing 1 changed file with 14 additions and 6 deletions.
diff --git a/openapi/schema/request/observations_updates.js b/openapi/schema/request/observations_updates.js
@@ -1,12 +1,20 @@
 const Joi = require( "joi" );
 
 module.exports = Joi.object( ).keys( {
-  created_after: Joi.string( ),
-  viewed: Joi.boolean( ),
-  observations_by: Joi.string( ).valid(
-    "owner",
-    "following"
-  ),
+  created_after: Joi.string( )
+    .description( "ISO8601 datetime after which the update was created" ),
+  viewed: Joi.boolean( )
+    .description(
+      "When false this only returns updates that have not been viewed "
+      + "by the authenticated user. When true it returns all updates."
+    )
+    .default( true ),
+  observations_by: Joi.string( )
+    .valid( "owner", "following" )
+    .description(
+      "Restrict to updates on observations by the authenticated user (owner) "
+      + "or on observations the authenticated user is following"
+    ),
   page: Joi.number( ).integer( ),
   per_page: Joi.number( ).integer( ),
   fields: Joi.any( )