X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2FSPECS;h=e5cc21b92411f40b6c3316863a20d2ead301c3c9;hb=4bda8288fb2fba14d02359f636375ca128aaad02;hp=d2de137aab30421be9787be3552b7b0c906cf03d;hpb=c69ee87c10818267f991236201150b1fa51ae519;p=openvswitch diff --git a/ovsdb/SPECS b/ovsdb/SPECS index d2de137a..e5cc21b9 100644 --- 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). - + Any JSON value. + + + Any JSON value except null. + A JSON object with the following members: @@ -169,12 +173,11 @@ is represented by , as described below. or a JSON object with the following members: "type": required + "enum": optional "minInteger": optional, integers only "maxInteger": optional, integers only "minReal": optional, reals only "maxReal": optional, reals only - "reMatch": optional, strings only - "reComment": optional, strings only "minLength": optional, strings only "maxLength": optional, strings only "refTable": optional, uuids only @@ -182,6 +185,13 @@ is represented by , as described below. An by itself is equivalent to a JSON object with a single member "type" whose value is the . + "enum" may be specified as a 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 are limited to + those in the . + + "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 @@ -192,23 +202,11 @@ is represented by , as described below. 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 @@ -250,7 +248,7 @@ Request object members: "method": "list_dbs" required "params": [] required - "id": any JSON value except null required + "id": required Response object members: @@ -269,7 +267,7 @@ Request object members: "method": "get_schema" required "params": [] required - "id": any JSON value except null required + "id": required Response object members: @@ -287,7 +285,7 @@ Request object members: "method": "transact" required "params": [, *] required - "id": any JSON value except null required + "id": required Response object members: @@ -395,9 +393,9 @@ monitor Request object members: - "method": "monitor" required - "params": [, , ] required - "id": any JSON value except null required + "method": "monitor" required + "params": [, , ] required + "id": required is an object that maps from a table name to a . @@ -461,11 +459,11 @@ update Notification object members: "method": "update" - "params": [, ] + "params": [, ] "id": null -The in "params" is the same as the value passed as the -in "params" for the "monitor" request. +The in "params" is the same as the value passed as the + in "params" for the "monitor" request. is an object that maps from a table name to a . @@ -504,8 +502,8 @@ monitor_cancel Request object members: "method": "monitor_cancel" required - "params": [] required - "id": any JSON value except null required + "params": [] required + "id": required Response object members: @@ -513,10 +511,10 @@ Response object members: "error": null "id": the request "id" member -Cancels the ongoing table monitor request, identified by the -in "params" matching the 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 + in "params" matching the in "params" for an +ongoing "monitor" request. No more "update" messages will be sent for +this table monitor. echo .... @@ -525,7 +523,7 @@ Request object members: "method": "echo" required "params": JSON array with any contents required - "id": required + "id": required Response object members: