chore: Update CHANGELOG.MD for jsonSchemaValidator change (#443)

yavorona · web-flow · commit fd18bfe2b5de · 2020-04-08T16:05:33.000-07:00
Summary: Changed functionality of JSON schema validation by removing skipJSONValidation entirely. Now user will need to import jsonSchemaValidator from @optimizely/optimizely-sdk/lib/utils/json_schema_validator and pass it to createInstance when validation is desired. Issues: pr #442 OASIS-6102 Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>
diff --git a/packages/optimizely-sdk/CHANGELOG.MD b/packages/optimizely-sdk/CHANGELOG.MD
@@ -10,7 +10,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [4.0.0-alpha.1] - March 4, 2020
 
 ### Breaking Changes:
-- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417))
+- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417)).
+- Changed functionality of JSON schema validation in all entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)).
+   - Previously, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated.
+   - Now, `skipJSONValidation` has been removed entirely from all entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below:
+   
+  ```js
+  const optimizelySDK = require('@optimizely/optimizely-sdk');
+  const jsonSchemaValidator = require('@optimizely/optimizely-sdk/lib/utils/json_schema_validator');
+  
+  // Require JSON schema validation for the datafile
+  var optimizelyClientInstance = optimizely.createInstance({
+    datafile: datafile,
+    jsonSchemaValidator: jsonSchemaValidator,
+  });
+  ```
 
 ## [3.6.0-alpha.1] - March 4, 2020
 
