EPL-10059 Release json_schema 2.0.0-RC3

[rmconsole-readonly-wk]

Pull Requests included in release:

• use dart base image
• WAP-1507 Final 2.0 Cleanup and Documentation

Requested by: @michaelcarter-wf

Diff Between Last Tag and Proposed Release: 2.0.0-RC2...Workiva:release_json_schema_2.0.0-rc3
Diff Between Last Tag and New Tag: 2.0.0-RC2...2.0.0-RC3

The logs for the request that created this PR can be found here

[aviary2-wf]

Security Insights

No security relevant content was detected by automated scans.

Action Items

• Review PR for security impact; comment "security review required" if needed or unsure
• Verify aviary.yaml coverage of security relevant code

---

Questions or Comments? Reach out on HipChat: InfoSec Forum.

[semveraudit-wf]

Public API Changes

Release PR detected; using previous release (2.0.0-RC2) as the diff base.

Recommendation: **:bangbang: Major version bump (fyi @Workiva/semver-audit-group )**

@@ line 46: package:json_schema/src/json_schema/browser/platform_functions.dart @@
-  Future<JsonSchema> createSchemaFromUrlBrowser(String schemaUrl, {String schemaVersion});
+  Future<JsonSchema> createSchemaFromUrlBrowser(String schemaUrl, {SchemaVersion schemaVersion});
// `type` of `schemaVersion` has changed.
// Changing a parameter signature is a major change.

@@ line 47: package:json_schema/src/json_schema/vm/platform_functions.dart @@
-  Future<JsonSchema> createSchemaFromUrlVm(String schemaUrl, {String schemaVersion});
+  Future<JsonSchema> createSchemaFromUrlVm(String schemaUrl, {SchemaVersion schemaVersion});
// `type` of `schemaVersion` has changed.
// Changing a parameter signature is a major change.

@@ line 47: package:json_schema/src/json_schema/validator.dart @@
class Validator {}
-     bool validate(dynamic instance, [bool reportMultipleErrors = false]);
+     bool validate(dynamic instance, {bool reportMultipleErrors = false, bool parseJson = false});
//    `reportMultipleErrors` was removed.
//    Removing a parameter is a major change.

@@ line 64: package:json_schema/src/json_schema/json_schema.dart @@
class JsonSchema {}
-     String get schemaVersion;
+     SchemaVersion get schemaVersion;
//    `type` of `schemaVersion` has changed from `String` to `SchemaVersion`.
//    Changing a class field is a major change.

-     bool validate(dynamic instance);
+     bool validate(dynamic instance, {bool reportMultipleErrors = false, bool parseJson = false});
//    `parseJson` was added.
//    Adding an optional parameter is a minor change.

-     Future<JsonSchema> createSchemaFromUrl(String schemaUrl, {String schemaVersion});
+     Future<JsonSchema> createSchemaFromUrl(String schemaUrl, {SchemaVersion schemaVersion});
//    `type` of `schemaVersion` has changed.
//    Changing a parameter signature is a major change.

-     JsonSchema createSchema(dynamic data, {String schemaVersion, Uri fetchedFromUri, RefProvider refProvider});
+     JsonSchema createSchema(dynamic schema, {SchemaVersion schemaVersion, Uri fetchedFromUri, RefProvider refProvider});
//    `type` of `schemaVersion` has changed.
//    Changing a parameter signature is a major change.

-     Set<dynamic> get paths;
//    Removing a field is a major change.

-     bool get additionalProperties;
//    Removing a field is a major change.

-     dynamic get additionalItems;
//    Removing a field is a major change.

-     List<SchemaType> get schemaTypeList;
//    Removing a field is a major change.

-     Future<JsonSchema> createSchemaAsync(dynamic data, {String schemaVersion, Uri fetchedFromUri, RefProviderAsync refProvider});
+     Future<JsonSchema> createSchemaAsync(dynamic schema, {SchemaVersion schemaVersion, Uri fetchedFromUri, RefProviderAsync refProvider});
//    `type` of `schemaVersion` has changed.
//    Changing a parameter signature is a major change.

+     List<SchemaType> get typeList;
//    Adding a field is a minor change.

+     bool get additionalItemsBool;
//    Adding a field is a minor change.

+     List<dynamic> get examples;
//    Adding a field is a minor change.

+     JsonSchema get additionalItemsSchema;
//    Adding a field is a minor change.

+     bool get additionalPropertiesBool;
//    Adding a field is a minor change.

+     SchemaType get type;
//    Adding a field is a minor change.

+     String toJson();
//    Adding a method is a minor change.

@@ line 76: package:json_schema/src/json_schema/constants.dart @@
-  class JsonSchemaVersions {}
// Removing a class is a major change.

-     static String get draft4;
//    Removing a field is a major change.

-     static String get draft6;
//    Removing a field is a major change.

-     static List<String> allVersions = const [draft4, draft6];
//    Removing a field is a major change.

-     JsonSchemaVersions();
//    Removing a constructor is a major change.

      From dart:core/object.dart
-     bool ==(other);
//    Removing a method is a major change.
-     Type get runtimeType;
//    Removing a field is a major change.
-     int get hashCode;
//    Removing a field is a major change.
-     String toString();
//    Removing a method is a major change.
-     dynamic noSuchMethod(Invocation invocation);
//    Removing a method is a major change.

Click to see 2 more API Changes

---

@@ line 39: package:json_schema/src/json_schema/schema_type.dart @@
class SchemaType implements Comparable<T> {}
-     static SchemaType get NULL;
//    Removing a field is a major change.

-     static SchemaType get BOOLEAN;
//    Removing a field is a major change.

-     static SchemaType get ARRAY;
//    Removing a field is a major change.

-     static SchemaType get STRING;
//    Removing a field is a major change.

-     static SchemaType get OBJECT;
//    Removing a field is a major change.

-     static SchemaType get INTEGER;
//    Removing a field is a major change.

-     static SchemaType get NUMBER;
//    Removing a field is a major change.

+     static SchemaType get number;
//    Adding a field is a minor change.

+     static SchemaType get object;
//    Adding a field is a minor change.

+     static SchemaType get array;
//    Adding a field is a minor change.

+     static SchemaType get string;
//    Adding a field is a minor change.

+     static SchemaType get integer;
//    Adding a field is a minor change.

+     static SchemaType get nullValue;
//    Adding a field is a minor change.

+     static SchemaType get boolean;
//    Adding a field is a minor change.

@@ line 74: package:json_schema/src/json_schema/constants.dart @@
+  class SchemaVersion implements Comparable<T> {}
// Adding a class is a minor change.

+     SchemaVersion fromString(String s);
//    Adding a method is a minor change.

+     static List<SchemaVersion> get values;
//    Adding a field is a minor change.

+     int get value;
//    Adding a field is a minor change.

+     static SchemaVersion get draft4;
//    Adding a field is a minor change.

+     static SchemaVersion get draft6;
//    Adding a field is a minor change.

+     int compareTo(SchemaVersion other);
//    Adding a method is a minor change.

+     SchemaVersion copy();
//    Adding a method is a minor change.

+     String toString();
//    Adding a method is a minor change.

+     int get hashCode;
//    Adding a field is a minor change.

---

Showing results for d906099

Powered by semver-audit-service. Please report any problems by filing an issue.
Reported by the dart semver audit client 1.4.0
Browse public API.

Last edited UTC Nov 07 at 21:23:55

[codecov-io]

Codecov Report

Merging #35 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #35   +/-   ##
=======================================
  Coverage   91.19%   91.19%           
=======================================
  Files          12       12           
  Lines         738      738           
=======================================
  Hits          673      673           
  Misses         65       65

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 04e7f6d...d906099. Read the comment docs.

[michaelcarter-wf]

+1

[michaelcarter-wf]

@Workiva/release-management-p

[jordanross-wf]

semver +1

[michaelcarter-wf]

@Workiva/release-management-p