Revise docs for bypassDocumentValidation option

jmikola · jmikola · commit c2314d6c84a3 · 2017-08-07T18:29:02.000-04:00
diff --git a/docs/includes/apiargs-MongoDBCollection-common-option.yaml b/docs/includes/apiargs-MongoDBCollection-common-option.yaml
@@ -4,6 +4,9 @@ type: boolean
 description: |
    If ``true``, allows the write operation to circumvent document level
    validation. Defaults to ``false``.
+
+   This option is available in MongoDB 3.2+ and is ignored for older server
+   versions, which do not support document level validation.
 interface: phpmethod
 operation: ~
 optional: true
diff --git a/src/Operation/Aggregate.php b/src/Operation/Aggregate.php
@@ -62,8 +62,8 @@ class Aggregate implements Executable
      *
      *  * batchSize (integer): The number of documents to return per batch.
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation. This only applies when the $out
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation. This only applies when the $out
      *    stage is specified.
      *
      *    For servers < 3.2, this option is ignored as document level validation
diff --git a/src/Operation/BulkWrite.php b/src/Operation/BulkWrite.php
@@ -86,8 +86,11 @@ class BulkWrite implements Executable
      *
      * Supported options for the bulk write operation:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation. The default is false.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * ordered (boolean): If true, when an insert fails, return without
      *    performing the remaining writes. If false, when a write fails,
diff --git a/src/Operation/FindAndModify.php b/src/Operation/FindAndModify.php
@@ -54,8 +54,11 @@ class FindAndModify implements Executable
      *    This is not supported for server versions < 3.4 and will result in an
      *    exception at execution time if used.
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * fields (document): Limits the fields to return for the matching
      *    document.
diff --git a/src/Operation/FindOneAndReplace.php b/src/Operation/FindOneAndReplace.php
@@ -41,8 +41,11 @@ class FindOneAndReplace implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *
diff --git a/src/Operation/FindOneAndUpdate.php b/src/Operation/FindOneAndUpdate.php
@@ -41,8 +41,11 @@ class FindOneAndUpdate implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *
diff --git a/src/Operation/InsertMany.php b/src/Operation/InsertMany.php
@@ -45,8 +45,11 @@ class InsertMany implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * ordered (boolean): If true, when an insert fails, return without
      *    performing the remaining writes. If false, when a write fails,
diff --git a/src/Operation/InsertOne.php b/src/Operation/InsertOne.php
@@ -45,8 +45,11 @@ class InsertOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
diff --git a/src/Operation/ReplaceOne.php b/src/Operation/ReplaceOne.php
@@ -39,8 +39,11 @@ class ReplaceOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *
diff --git a/src/Operation/Update.php b/src/Operation/Update.php
@@ -50,8 +50,11 @@ class Update implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *
diff --git a/src/Operation/UpdateMany.php b/src/Operation/UpdateMany.php
@@ -39,8 +39,11 @@ class UpdateMany implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *
diff --git a/src/Operation/UpdateOne.php b/src/Operation/UpdateOne.php
@@ -39,8 +39,11 @@ class UpdateOne implements Executable
      *
      * Supported options:
      *
-     *  * bypassDocumentValidation (boolean): If true, allows the write to opt
-     *    out of document level validation.
+     *  * bypassDocumentValidation (boolean): If true, allows the write to
+     *    circumvent document level validation.
+     *
+     *    For servers < 3.2, this option is ignored as document level validation
+     *    is not available.
      *
      *  * collation (document): Collation specification.
      *

Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,8 @@ class Aggregate implements Executable`
`62`	`62`	`*`
`63`	`63`	`* * batchSize (integer): The number of documents to return per batch.`
`64`	`64`	`*`
`65`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`66`		`- * out of document level validation. This only applies when the $out`
	`65`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`66`	`+ * circumvent document level validation. This only applies when the $out`
`67`	`67`	`* stage is specified.`
`68`	`68`	`*`
`69`	`69`	`* For servers < 3.2, this option is ignored as document level validation`
Original file line number	Diff line number	Diff line change
`@@ -86,8 +86,11 @@ class BulkWrite implements Executable`
`86`	`86`	`*`
`87`	`87`	`* Supported options for the bulk write operation:`
`88`	`88`	`*`
`89`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`90`		`- * out of document level validation.`
	`89`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`90`	`+ * circumvent document level validation. The default is false.`
	`91`	`+ *`
	`92`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`93`	`+ * is not available.`
`91`	`94`	`*`
`92`	`95`	`* * ordered (boolean): If true, when an insert fails, return without`
`93`	`96`	`* performing the remaining writes. If false, when a write fails,`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,11 @@ class FindAndModify implements Executable`
`54`	`54`	`* This is not supported for server versions < 3.4 and will result in an`
`55`	`55`	`* exception at execution time if used.`
`56`	`56`	`*`
`57`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`58`		`- * out of document level validation.`
	`57`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`58`	`+ * circumvent document level validation.`
	`59`	`+ *`
	`60`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`61`	`+ * is not available.`
`59`	`62`	`*`
`60`	`63`	`* * fields (document): Limits the fields to return for the matching`
`61`	`64`	`* document.`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,11 @@ class FindOneAndReplace implements Executable`
`41`	`41`	`*`
`42`	`42`	`* Supported options:`
`43`	`43`	`*`
`44`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`45`		`- * out of document level validation.`
	`44`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`45`	`+ * circumvent document level validation.`
	`46`	`+ *`
	`47`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`48`	`+ * is not available.`
`46`	`49`	`*`
`47`	`50`	`* * collation (document): Collation specification.`
`48`	`51`	`*`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,11 @@ class FindOneAndUpdate implements Executable`
`41`	`41`	`*`
`42`	`42`	`* Supported options:`
`43`	`43`	`*`
`44`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`45`		`- * out of document level validation.`
	`44`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`45`	`+ * circumvent document level validation.`
	`46`	`+ *`
	`47`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`48`	`+ * is not available.`
`46`	`49`	`*`
`47`	`50`	`* * collation (document): Collation specification.`
`48`	`51`	`*`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,11 @@ class InsertMany implements Executable`
`45`	`45`	`*`
`46`	`46`	`* Supported options:`
`47`	`47`	`*`
`48`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`49`		`- * out of document level validation.`
	`48`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`49`	`+ * circumvent document level validation.`
	`50`	`+ *`
	`51`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`52`	`+ * is not available.`
`50`	`53`	`*`
`51`	`54`	`* * ordered (boolean): If true, when an insert fails, return without`
`52`	`55`	`* performing the remaining writes. If false, when a write fails,`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,11 @@ class InsertOne implements Executable`
`45`	`45`	`*`
`46`	`46`	`* Supported options:`
`47`	`47`	`*`
`48`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`49`		`- * out of document level validation.`
	`48`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`49`	`+ * circumvent document level validation.`
	`50`	`+ *`
	`51`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`52`	`+ * is not available.`
`50`	`53`	`*`
`51`	`54`	`* * writeConcern (MongoDB\Driver\WriteConcern): Write concern.`
`52`	`55`	`*`
Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,11 @@ class ReplaceOne implements Executable`
`39`	`39`	`*`
`40`	`40`	`* Supported options:`
`41`	`41`	`*`
`42`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`43`		`- * out of document level validation.`
	`42`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`43`	`+ * circumvent document level validation.`
	`44`	`+ *`
	`45`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`46`	`+ * is not available.`
`44`	`47`	`*`
`45`	`48`	`* * collation (document): Collation specification.`
`46`	`49`	`*`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,11 @@ class Update implements Executable`
`50`	`50`	`*`
`51`	`51`	`* Supported options:`
`52`	`52`	`*`
`53`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`54`		`- * out of document level validation.`
	`53`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`54`	`+ * circumvent document level validation.`
	`55`	`+ *`
	`56`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`57`	`+ * is not available.`
`55`	`58`	`*`
`56`	`59`	`* * collation (document): Collation specification.`
`57`	`60`	`*`
Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,11 @@ class UpdateMany implements Executable`
`39`	`39`	`*`
`40`	`40`	`* Supported options:`
`41`	`41`	`*`
`42`		`- * * bypassDocumentValidation (boolean): If true, allows the write to opt`
`43`		`- * out of document level validation.`
	`42`	`+ * * bypassDocumentValidation (boolean): If true, allows the write to`
	`43`	`+ * circumvent document level validation.`
	`44`	`+ *`
	`45`	`+ * For servers < 3.2, this option is ignored as document level validation`
	`46`	`+ * is not available.`
`44`	`47`	`*`
`45`	`48`	`* * collation (document): Collation specification.`
`46`	`49`	`*`