Feature/release schema 1.2.0 (#551)

* Export aion validator, update documentation * Prep release veritone-json-schema 1.2.0
veritone · Jun 24, 2021 · 4596ef0 · 4596ef0
1 parent 0eafd1d
commit 4596ef0
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 3 deletions.
diff --git a/packages/veritone-json-schemas/CHANGELOG.md b/packages/veritone-json-schemas/CHANGELOG.md
@@ -55,5 +55,7 @@
 * Adds support for Anomaly Detection Engines
 
 ## 1.1.1
+* Update lodash
 
-* update lodash
+## 1.2.0
+* Add validation support for the AI Object Notation (AION) file type [application/vnd.veritone.aion+json](https://www.iana.org/assignments/media-types/application/vnd.veritone.aion+json)
diff --git a/packages/veritone-json-schemas/README.md b/packages/veritone-json-schemas/README.md
@@ -29,6 +29,23 @@ It also outputs all the json-schemas and the valid and invalid examples used in
 > And we try to keep our schemas simple and not use too many advanced features to increase the chance of compatibility with other packages.
 > So if you do use another package to parse our json-schemas, hopefully things will "just work" but don't be surprised if there's a few quirks.
 
+## AI Object Notation (AION)
+
+The AION validator is in a different class than the other validators. Most validators are tied to the `validationContracts`
+value and are for validating a file for a specific capability like transcription, concepts, object detection, etc. In contrast
+the AION validator will validate an entire file regardless of what specific types of data it represents. Just because a 
+file is a valid AION file does not automatically make it valid for any given capability as different capabilities require
+specific fields for that capability. For instance, a transcription file **MUST** contain a `series` of `words` to be valid,
+but an AION file only **MAY** contain a series of words. Being a valid AION file is _necessary_ for a capability but not 
+_sufficient_ for a capability.
+
+So what is the AION validator for then? It has two purposes:
+1. It enforces a schema that validates any `application/vnd.veritone.aion+json` Media Type file (f.k.a. MIME Types). 
+   See [IANA's list of Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml) for details.
+2. It can be used for any "vtn-standard" file, even those for which a specific validation contract is not available. 
+   For instance, at the time of writing, there is no specific validation contract for validating "location detection", 
+   but you can use the AION validator to ensure that your GPS data conforms to the expected format.
+
 ## Contributing
 
 > See the [veritone-sdk README](../../README.md) for full information.
@@ -40,7 +57,7 @@ It also outputs all the json-schemas and the valid and invalid examples used in
 
 ## License
 
-Copyright 2019, Veritone Inc.
+Copyright 2019-2021, Veritone Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/packages/veritone-json-schemas/package.json b/packages/veritone-json-schemas/package.json
@@ -1,6 +1,6 @@
 {
   "name": "veritone-json-schemas",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "JSON Schemas, their examples, and helper functions used across Veritone",
   "repository": "https://github.com/veritone/veritone-sdk",
   "author": {

diff --git a/packages/veritone-json-schemas/src/index.js b/packages/veritone-json-schemas/src/index.js
@@ -134,6 +134,7 @@ const VALIDATORS = {
 
 export {
   VALIDATORS,
+  verifyAion,
   verifyConcept,
   verifyEntity,
   verifyKeyword,