projects / openvswitch / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
json: Fix typo in error message.
[openvswitch] / ovsdb / SPECS
diff --git a/ovsdb/SPECS b/ovsdb/SPECS
index d2de137aab30421be9787be3552b7b0c906cf03d..e5cc21b92411f40b6c3316863a20d2ead301c3c9 100644 (file)
--- a/ovsdb/SPECS
+++ b/ovsdb/SPECS
@@ -33,10 +33,14 @@ values.  Additional notation is presented later.
     A JSON number with an integer value, within a certain range
     (currently -2**63...+2**63-1).
 
     A JSON number with an integer value, within a certain range
     (currently -2**63...+2**63-1).
 
-<value>
+<json-value>
 
     Any JSON value.
 
 
     Any JSON value.
 
+<nonnull-json-value>
+
+    Any JSON value except null.
+
 <error>
 
     A JSON object with the following members:
 <error>
 
     A JSON object with the following members:
@@ -169,12 +173,11 @@ is represented by <database-schema>, as described below.
     <atomic-type> or a JSON object with the following members:
 
         "type": <atomic-type>              required
     <atomic-type> or a JSON object with the following members:
 
         "type": <atomic-type>              required
+        "enum": <value>                    optional
         "minInteger": <integer>            optional, integers only
         "maxInteger": <integer>            optional, integers only
         "minReal": <real>                  optional, reals only
         "maxReal": <real>                  optional, reals only 
         "minInteger": <integer>            optional, integers only
         "maxInteger": <integer>            optional, integers only
         "minReal": <real>                  optional, reals only
         "maxReal": <real>                  optional, reals only 
-        "reMatch": <string>                optional, strings only
-        "reComment": <string>              optional, strings only
         "minLength": <integer>             optional, strings only
         "maxLength": <integer>             optional, strings only
         "refTable": <id>                   optional, uuids only
         "minLength": <integer>             optional, strings only
         "maxLength": <integer>             optional, strings only
         "refTable": <id>                   optional, uuids only
@@ -182,6 +185,13 @@ is represented by <database-schema>, as described below.
     An <atomic-type> by itself is equivalent to a JSON object with a
     single member "type" whose value is the <atomic-type>.
 
     An <atomic-type> by itself is equivalent to a JSON object with a
     single member "type" whose value is the <atomic-type>.
 
+    "enum" may be specified as a <value> whose type is a set of one
+    or more values specified for the member "type".  If "enum" is
+    specified, then the valid values of the <base-type> are limited to
+    those in the <value>.
+
+    "enum" is mutually exclusive with the following constraints.
+
     If "type" is "integer", then "minInteger" or "maxInteger" or both
     may also be specified, restricting the valid integer range.  If
     both are specified, then the maxInteger must be greater than or
     If "type" is "integer", then "minInteger" or "maxInteger" or both
     may also be specified, restricting the valid integer range.  If
     both are specified, then the maxInteger must be greater than or
@@ -192,23 +202,11 @@ is represented by <database-schema>, as described below.
     specified, then the maxReal must be greater than or equal to
     minReal.
 
     specified, then the maxReal must be greater than or equal to
     minReal.
 
-    If "type" is "string", then:
-
-        "reMatch" may be a JavaScript (Perl 5-like) regular expression
-        that restricts the allowed values.  The regular expression
-        must match the entire string value, that is, it is treated as
-        if it begins with ^ and ends with $, regardless of whether it
-        really does.
-
-        If "reMatch" is specified, then "reComment" may be a string
-        that describes the allowed values, phrased so that it fits
-        into a sentence such as "This value must be...".
-
-        "minLength" and "maxLength" or both may be specified,
-        restricting the valid length of value strings.  If both are
-        specified, then maxLength must be greater than or equal to
-        minLength.  String length is measured in characters (not bytes
-        or UTF-16 code units).
+    If "type" is "string", then "minLength" and "maxLength" or both
+    may be specified, restricting the valid length of value strings.
+    If both are specified, then maxLength must be greater than or
+    equal to minLength.  String length is measured in characters (not
+    bytes or UTF-16 code units).
 
     If "type" is "uuid", then "refTable", if present, must be the name
     of a table within this database.  If "refTable" is set, the
 
     If "type" is "uuid", then "refTable", if present, must be the name
     of a table within this database.  If "refTable" is set, the
@@ -250,7 +248,7 @@ Request object members:
 
     "method": "list_dbs"              required
     "params": []                      required
 
     "method": "list_dbs"              required
     "params": []                      required
-    "id": any JSON value except null  required
+    "id": <nonnull-json-value>        required
 
 Response object members:
 
 
 Response object members:
 
@@ -269,7 +267,7 @@ Request object members:
 
     "method": "get_schema"            required
     "params": [<db-name>]             required
 
     "method": "get_schema"            required
     "params": [<db-name>]             required
-    "id": any JSON value except null  required
+    "id": <nonnull-json-value>        required
 
 Response object members:
 
 
 Response object members:
 
@@ -287,7 +285,7 @@ Request object members:
 
     "method": "transact"                  required
     "params": [<db-name>, <operation>*]   required
 
     "method": "transact"                  required
     "params": [<db-name>, <operation>*]   required
-    "id": any JSON value except null      required
+    "id": <nonnull-json-value>            required
 
 Response object members:
 
 
 Response object members:
 
@@ -395,9 +393,9 @@ monitor
 
 Request object members:
 
 
 Request object members:
 
-    "method": "monitor"                                   required
-    "params": [<db-name>, <value>, <monitor-requests>]    required
-    "id": any JSON value except null                      required
+    "method": "monitor"                                       required
+    "params": [<db-name>, <json-value>, <monitor-requests>]   required
+    "id": <nonnull-json-value>                                required
 
 <monitor-requests> is an object that maps from a table name to a
 <monitor-request>.
 
 <monitor-requests> is an object that maps from a table name to a
 <monitor-request>.
@@ -461,11 +459,11 @@ update
 Notification object members:
 
     "method": "update"
 Notification object members:
 
     "method": "update"
-    "params": [<value>, <table-updates>]
+    "params": [<json-value>, <table-updates>]
     "id": null
 
     "id": null
 
-The <value> in "params" is the same as the value passed as the <value>
-in "params" for the "monitor" request.
+The <json-value> in "params" is the same as the value passed as the
+<json-value> in "params" for the "monitor" request.
 
 <table-updates> is an object that maps from a table name to a
 <table-update>.
 
 <table-updates> is an object that maps from a table name to a
 <table-update>.
@@ -504,8 +502,8 @@ monitor_cancel
 Request object members:
 
     "method": "monitor_cancel"                              required
 Request object members:
 
     "method": "monitor_cancel"                              required
-    "params": [<value>]                                     required
-    "id": any JSON value except null                        required
+    "params": [<json-value>]                                required
+    "id": <nonnull-json-value>                              required
 
 Response object members:
 
 
 Response object members:
 
@@ -513,10 +511,10 @@ Response object members:
     "error": null
     "id": the request "id" member
 
     "error": null
     "id": the request "id" member
 
-Cancels the ongoing table monitor request, identified by the <value>
-in "params" matching the <value> in "params" for an ongoing "monitor"
-request.  No more "update" messages will be sent for this table
-monitor.
+Cancels the ongoing table monitor request, identified by the
+<json-value> in "params" matching the <json-value> in "params" for an
+ongoing "monitor" request.  No more "update" messages will be sent for
+this table monitor.
 
 echo
 ....
 
 echo
 ....
@@ -525,7 +523,7 @@ Request object members:
 
     "method": "echo"                                required
     "params": JSON array with any contents          required
 
     "method": "echo"                                required
     "params": JSON array with any contents          required
-    "id": <value>                                   required
+    "id": <json-value>                              required
 
 Response object members:
 
 
 Response object members:
 
Unnamed repository; edit this file to name it for gitweb.