RDoc-2566 Added default values

ravendb · Jan 31, 2024 · 728447d · 728447d
1 parent b90d011
commit 728447d
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 12 deletions.
diff --git a/Documentation/5.2/Raven.Documentation.Pages/client-api/operations/.docs.json b/Documentation/5.2/Raven.Documentation.Pages/client-api/operations/.docs.json
@@ -12,12 +12,12 @@
     },
     {
         "Path": "/common",
-        "Name": "Common",
+        "Name": "Common Operations",
         "Mappings": []
     },
     {
         "Path": "/maintenance",
-        "Name": "Maintenance",
+        "Name": "Maintenance Operations",
         "Mappings": []
     },
     {

diff --git a/...2/Samples/csharp/Raven.Documentation.Samples/ClientApi/Operations/Common/DeleteByQuery.cs b/...2/Samples/csharp/Raven.Documentation.Samples/ClientApi/Operations/Common/DeleteByQuery.cs
@@ -260,17 +260,21 @@ DeleteByQueryOperation DeleteByQueryOperation<TEntity, TIndexCreator>(
             public class QueryOperationOptions
             {
                 // Indicates whether operations are allowed on stale indexes.
+                // DEFAULT: false
                 public bool AllowStale { get; set; }
                 
                 // If AllowStale is set to false and index is stale, 
                 // then this is the maximum timeout to wait for index to become non-stale. 
                 // If timeout is exceeded then exception is thrown.
+                // DEFAULT: null (if index is stale then exception is thrown immediately) 
                 public TimeSpan? StaleTimeout { get; set; }
                 
                 // Limits the number of base operations per second allowed.
+                // DEFAULT: no limit
                 public int? MaxOpsPerSecond
                 
                 // Determines whether operation details about each document should be returned by server.
+                // DEFAULT: false
                 public bool RetrieveDetails { get; set; }
                 
                 // Ignore the maximum number of statements a script can execute.

diff --git a/Documentation/5.2/Samples/nodejs/ClientApi/Operations/Common/deleteByQuery.js b/Documentation/5.2/Samples/nodejs/ClientApi/Operations/Common/deleteByQuery.js
@@ -117,14 +117,17 @@ const session = store.openSession();
     // options object
     {
         // Indicates whether operations are allowed on stale indexes.
+        // DEFAULT: false
         allowStale, // boolean
 
-        // If AllowStale is set to false and index is stale, 
-        // then this is the maximum timeout to wait for index to become non-stale. 
+        // If AllowStale is set to false and index is stale,
+        // then this is the maximum timeout to wait for index to become non-stale.
         // If timeout is exceeded then exception is thrown.
-        staleTimeout, // number
+        // DEFAULT: null (if index is stale then exception is thrown immediately)
+        staleTimeout, // number 
 
-        // Limits the number of base operations per second allowed.  
+        // Limits the number of base operations per second allowed.
+        // DEFAULT: null (no limit)
         maxOpsPerSecond, // number
     }
     //endregion

diff --git a/Documentation/5.3/Raven.Documentation.Pages/client-api/operations/.docs.json b/Documentation/5.3/Raven.Documentation.Pages/client-api/operations/.docs.json
@@ -12,12 +12,12 @@
     },
     {
         "Path": "/common",
-        "Name": "Common",
+        "Name": "Common Operations",
         "Mappings": []
     },
     {
         "Path": "/maintenance",
-        "Name": "Maintenance",
+        "Name": "Maintenance Operations",
         "Mappings": []
     },
     {

diff --git a/Documentation/5.4/Raven.Documentation.Pages/client-api/operations/.docs.json b/Documentation/5.4/Raven.Documentation.Pages/client-api/operations/.docs.json
@@ -12,12 +12,12 @@
     },
     {
         "Path": "/common",
-        "Name": "Common",
+        "Name": "Common Operations",
         "Mappings": []
     },
     {
         "Path": "/maintenance",
-        "Name": "Maintenance",
+        "Name": "Maintenance Operations",
         "Mappings": []
     },
     {

diff --git a/Documentation/6.0/Raven.Documentation.Pages/client-api/operations/.docs.json b/Documentation/6.0/Raven.Documentation.Pages/client-api/operations/.docs.json
@@ -12,12 +12,12 @@
     },
     {
         "Path": "/common",
-        "Name": "Common",
+        "Name": "Common Operations",
         "Mappings": []
     },
     {
         "Path": "/maintenance",
-        "Name": "Maintenance",
+        "Name": "Maintenance Operations",
         "Mappings": []
     },
     {