Mercurial > hg > piper

changeset 159:a99929c1df42

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Revise descriptions
author Chris Cannam <c.cannam@qmul.ac.uk>
date Thu, 06 Oct 2016 12:12:41 +0100
parents 781de01a04eb
children 45fa68ee83ce
files schema/basic.json schema/configurationrequest.json schema/configurationresponse.json schema/configuredoutputdescriptor.json schema/enums.json schema/error.json schema/feature.json schema/featureset.json schema/finishrequest.json schema/finishresponse.json schema/listrequest.json schema/listresponse.json schema/loadrequest.json schema/loadresponse.json schema/outputdescriptor.json schema/parameterdescriptor.json schema/pluginconfiguration.json schema/pluginstaticdata.json schema/processinput.json schema/processrequest.json schema/processresponse.json schema/realtime.json schema/rpcresponse.json schema/valueextents.json
diffstat 24 files changed, 24 insertions(+), 24 deletions(-) [+]
line wrap: on
line diff
--- a/schema/basic.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/basic.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/basic#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for the basic part of various Vamp descriptors",
+    "description": "schema for a common unit of basic metadata",
     "type": "object",
     "properties": {
 	"identifier": {
--- a/schema/configurationrequest.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/configurationrequest.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/configurationrequest#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised request to configure a Vamp plugin; normally served as the content field of an object matching the plain request schema",
+    "description": "schema for a request to configure a feature extractor; may be served in the params field of a configure-method rpcrequest",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/configurationresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/configurationresponse.json	Thu Oct 06 12:12:41 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 serialised response to a request to configure a Vamp plugin; normally served as the content field of an object matching the plain response 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",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/configuredoutputdescriptor.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/configuredoutputdescriptor.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
   "id": "http://vamp-plugins.org/json/schema/configuredoutputdescriptor#",
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "schema for the non-static fields of a Vamp::Plugin::OutputDescriptor serialisation",
+  "description": "schema for the non-static metadata fields of an output descriptor belonging to a feature extractor",
   "type": "object",
   "properties": {
   "unit": {
--- a/schema/enums.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/enums.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/enums#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for Vamp serialisation enums",
+    "description": "schema for common feature extractor enum types",
     "definitions": {
 	"input_domain": {
 	    "type": "string",
--- a/schema/error.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/error.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/error#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for an error object in a response to a request",
+    "description": "schema for an error object in a response to an rpcrequest",
     "type": "object",
     "properties": {
 	"code": {
--- a/schema/feature.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/feature.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/feature#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a Vamp::Plugin::Feature serialisation",
+    "description": "schema for a single feature returned by a feature extractor",
     "type": "object",
     "properties": {
 	"timestamp": {
--- a/schema/featureset.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/featureset.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/featureset#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a Vamp::Plugin::FeatureSet serialisation",
+    "description": "schema for a set of features returned by a feature extractor, associating an output id with an array of features from that output",
     "type": "object",
     "patternProperties": {
 	"^[a-zA-Z0-9_-]+$": {
--- a/schema/finishrequest.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/finishrequest.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/finishrequest#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised request to finish processing with a Vamp plugin; normally served as the content field of an object matching the plain request schema",
+    "description": "schema for a serialised request to finish processing with a feature extractor; may be served in the params field of a finish-method rpcrequest",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/finishresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/finishresponse.json	Thu Oct 06 12:12:41 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 serialised response from finishing processing with a Vamp plugin; normally served as the content field of an object matching the plain response 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",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/listrequest.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/listrequest.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/listrequest#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised list request for feature extractors; normally served as the content field of an object matching the plain request schema",
+    "description": "schema for a list request for feature extractors; may be served in the params field of a list-method rpcrequest",
     "type": "object",
     "properties": {
     },
--- a/schema/listresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/listresponse.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/listresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised response to a request to list plugins; normally served as the content field of an object matching the plain response schema",
+    "description": "schema for a response to a request to list feature extractors; may be served in the result field of a list-method rpcresponse",
     "type": "object",
     "properties": {
 	"plugins": {
--- a/schema/loadrequest.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/loadrequest.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/loadrequest#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised load request for a Vamp Plugin; normally served as the content field of an object matching the plain request schema",
+    "description": "schema for a request to load a feature extractor; may be served in the params field of a load-method rpcrequest",
     "type": "object",
     "properties": {
 	"pluginKey": {
--- a/schema/loadresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/loadresponse.json	Thu Oct 06 12:12:41 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 serialised response to a load request for a Vamp Plugin; normally served as the content field of an object matching the plain response 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",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/outputdescriptor.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/outputdescriptor.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/outputdescriptor#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a Vamp::Plugin::OutputDescriptor serialisation",
+    "description": "schema for an output descriptor belonging to a feature extractor",
     "type": "object",
     "properties": {
 	"basic": {
--- a/schema/parameterdescriptor.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/parameterdescriptor.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/parameterdescriptor#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a Vamp::PluginBase::ParameterDescriptor serialisation",
+    "description": "schema for a metadata about an adjustable parameter of a feature extractor",
     "type": "object",
     "properties": {
 	"basic": {
--- a/schema/pluginconfiguration.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/pluginconfiguration.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/pluginconfiguration#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised bundle of configuration data associated with a Vamp Plugin",
+    "description": "schema for a bundle of configuration data capturing the setup of a feature extractor",
     "type": "object",
     "properties": {
 	"parameterValues": {
--- a/schema/pluginstaticdata.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/pluginstaticdata.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/pluginstaticdata#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised bundle of the static data associated with a Vamp Plugin",
+    "description": "schema for the static metadata associated with a feature extractor",
     "type": "object",
     "properties": {
 	"pluginKey": {
--- a/schema/processinput.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/processinput.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/processinput#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised input into a plugin process call",
+    "description": "schema for a chunk of input data provided to a process request",
     "type": "object",
     "properties": {
 	"timestamp": {
--- a/schema/processrequest.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/processrequest.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/processrequest#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised request to process a data block using a Vamp plugin; normally served as the content field of an object matching the plain request schema",
+    "description": "schema for a request to process a chunk of data using a feature extractor; may be served in the params field of a process-method rpcrequest",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/processresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/processresponse.json	Thu Oct 06 12:12:41 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 serialised response from processing a data block using a Vamp plugin; normally served as the content field of an object matching the plain response 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",
     "type": "object",
     "properties": {
 	"pluginHandle": {
--- a/schema/realtime.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/realtime.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/realtime#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a Vamp::RealTime serialisation",
+    "description": "schema for a timestamp given in seconds and nanoseconds",
     "type": "object",
     "properties": {
 	"s": { "type": "integer" },
--- a/schema/rpcresponse.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/rpcresponse.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/rpcresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a success or failure response to a request",
+    "description": "schema for a serialised response to an RPC request; compatible with JSON-RPC, except that the method name must be included here as well as in the request",
     "type": "object",
     "oneOf": [ {
         "properties": {
--- a/schema/valueextents.json	Thu Oct 06 11:23:25 2016 +0100
+++ b/schema/valueextents.json	Thu Oct 06 12:12:41 2016 +0100
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/valueextents#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for the extents structure in various Vamp descriptors",
+    "description": "schema for a structure giving the extents of a value range",
     "type": "object",
     "properties": {
 	"min": { "type": "number" },