changeset 176:fcfd51f42662

Make a few more fields compulsory, add note that *Response fields are only used for successful responses
author Chris Cannam <c.cannam@qmul.ac.uk>
date Tue, 11 Oct 2016 10:51:21 +0100
parents be122aec4bd1
children 729645a0e0ce
files json/examples/configurationresponse.json json/schema/configurationresponse.json json/schema/finishresponse.json json/schema/loadresponse.json json/schema/processinput.json json/schema/processresponse.json
diffstat 6 files changed, 8 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/json/examples/configurationresponse.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/examples/configurationresponse.json	Tue Oct 11 10:51:21 2016 +0100
@@ -1,1 +1,1 @@
-{"outputList": [{"basic": {"description": "Percussive note onset locations", "identifier": "onsets", "name": "Onsets"}, "configured": { "binCount": 0, "binNames": [], "hasDuration": false, "sampleRate": 44100, "sampleType": "VariableSampleRate", "unit": ""}}, {"basic": {"description": "Broadband energy rise detection function", "identifier": "detectionfunction", "name": "Detection Function"}, "configured": { "binCount": 1, "binNames": [""], "hasDuration": false, "quantizeStep": 1, "sampleRate": 44100, "sampleType": "OneSamplePerStep", "unit": ""}}]}
+{"handle": 14,"outputList": [{"basic": {"description": "Percussive note onset locations", "identifier": "onsets", "name": "Onsets"}, "configured": { "binCount": 0, "binNames": [], "hasDuration": false, "sampleRate": 44100, "sampleType": "VariableSampleRate", "unit": ""}}, {"basic": {"description": "Broadband energy rise detection function", "identifier": "detectionfunction", "name": "Detection Function"}, "configured": { "binCount": 1, "binNames": [""], "hasDuration": false, "quantizeStep": 1, "sampleRate": 44100, "sampleType": "OneSamplePerStep", "unit": ""}}]}
--- a/json/schema/configurationresponse.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/schema/configurationresponse.json	Tue Oct 11 10:51:21 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/configurationresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a response to a request to configure a feature extractor; may be served in the result field of a configure-method rpcresponse",
+    "description": "schema for a successful response to a request to configure a feature extractor; may be served in the result field of a configure-method rpcresponse",
     "type": "object",
     "properties": {
 	"handle": {
@@ -12,7 +12,7 @@
 	    "items": { "$ref": "http://vamp-plugins.org/json/schema/outputdescriptor#" }
 	}
     },
-    "required": [ "outputList" ],
+    "required": [ "handle", "outputList" ],
     "additionalProperties": false
 }
 
--- a/json/schema/finishresponse.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/schema/finishresponse.json	Tue Oct 11 10:51:21 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/finishresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a response to a request to finishing processing with a feature extractor; may be served in the result field of a finish-method rpcresponse",
+    "description": "schema for a successful response to a request to finishing processing with a feature extractor; may be served in the result field of a finish-method rpcresponse",
     "type": "object",
     "properties": {
 	"handle": {
--- a/json/schema/loadresponse.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/schema/loadresponse.json	Tue Oct 11 10:51:21 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/loadresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a response to a request to load a feature extractor; may be served in the result field of a load-method rpcresponse",
+    "description": "schema for a successful response to a request to load a feature extractor; may be served in the result field of a load-method rpcresponse",
     "type": "object",
     "properties": {
 	"handle": {
@@ -14,6 +14,7 @@
 	    "$ref": "http://vamp-plugins.org/json/schema/configuration#"
 	}
     },
+    "required": [ "handle", "staticData", "defaultConfiguration" ],
     "additionalProperties": false
 }
 
--- a/json/schema/processinput.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/schema/processinput.json	Tue Oct 11 10:51:21 2016 +0100
@@ -14,6 +14,7 @@
             }
         }
     },
+    "required": [ "timestamp", "inputBuffers" ],
     "additionalProperties": false
 }
 
--- a/json/schema/processresponse.json	Tue Oct 11 10:51:01 2016 +0100
+++ b/json/schema/processresponse.json	Tue Oct 11 10:51:21 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/processresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a response to a request to process a chunk of data using a feature extractor; may be served in the result field of a process-method rpcresponse",
+    "description": "schema for a successful response to a request to process a chunk of data using a feature extractor; may be served in the result field of a process-method rpcresponse",
     "type": "object",
     "properties": {
 	"handle": {