aboutsummaryrefslogtreecommitdiff
path: root/ovsdb
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2010-06-30 14:35:02 -0700
committerBen Pfaff <blp@nicira.com>2010-06-30 16:49:01 -0700
commit65e18fa85dde840da4a9cb956cf7bb2c0fc1d95c (patch)
tree5a9eef2c6a5e60167a7ad862e54ad52925b0a3c0 /ovsdb
parent597cf5a1c197e269ad4376364422e23f5405105f (diff)
ovsdb: Document in SPECS how OVS uses JSON.
CC: Jeremy Stribling <strib@nicira.com>
Diffstat (limited to 'ovsdb')
-rw-r--r--ovsdb/SPECS13
1 files changed, 13 insertions, 0 deletions
diff --git a/ovsdb/SPECS b/ovsdb/SPECS
index cbd69def..524e52f3 100644
--- a/ovsdb/SPECS
+++ b/ovsdb/SPECS
@@ -5,6 +5,19 @@
Basic Notation
--------------
+OVSDB uses JSON, as defined by RFC 4627, for its schema format and its
+wire protocol format. The JSON implementation in Open vSwitch has the
+following limitations:
+
+ - Null bytes (\u0000) are not allowed in strings.
+
+ - Only UTF-8 encoding is supported. (RFC 4627 also mentions
+ UTF-16BE, UTF-16LE, and UTF-32.)
+
+ - RFC 4627 says that names within a JSON object should be unique.
+ The Open vSwitch JSON parser discards all but the last value
+ for a name that is specified more than once.
+
The descriptions below use the following shorthand notations for JSON
values. Additional notation is presented later.