doc: Add some JSON examples to openflow api reference for of1.5

Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

1 files changed, 200 insertions, 0 deletions

diff --git a/doc/source/ofproto_v1_5_ref.rst b/doc/source/ofproto_v1_5_ref.rst
index f56e2cab..2ac0a837 100644
--- a/doc/source/ofproto_v1_5_ref.rst
+++ b/doc/source/ofproto_v1_5_ref.rst
@@ -12,22 +12,46 @@ Handshake
 
 .. autoclass:: OFPFeaturesRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-features_request.packet.json
+
 .. autoclass:: OFPSwitchFeatures
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-features_reply.packet.json
+
 Switch Configuration
 --------------------
 
 .. autoclass:: OFPSetConfig
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-set_config.packet.json
+
 .. autoclass:: OFPGetConfigRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_config_request.packet.json
+
 .. autoclass:: OFPGetConfigReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_config_reply.packet.json
+
 Modify State Messages
 ---------------------
 
 .. autoclass:: OFPTableMod
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_mod.packet.json
+
 .. autoclass:: OFPFlowMod
 
     JSON Example:
@@ -44,15 +68,31 @@ Modify State Messages
 
 .. autoclass:: OFPPortMod
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_mod.packet.json
+
 .. autoclass:: OFPMeterMod
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_mod.packet.json
+
 Multipart Messages
 ------------------
 
 .. autoclass:: OFPDescStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-desc_request.packet.json
+
 .. autoclass:: OFPDescStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-desc_reply.packet.json
+
 .. autoclass:: OFPFlowDescStatsRequest
 
     JSON Example:
@@ -67,6 +107,10 @@ Multipart Messages
 
 .. autoclass:: OFPFlowStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_stats_request.packet.json
+
 .. autoclass:: OFPFlowStatsReply
 
     JSON Example:
@@ -75,6 +119,10 @@ Multipart Messages
 
 .. autoclass:: OFPAggregateStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-aggregate_stats_request.packet.json
+
 .. autoclass:: OFPAggregateStatsReply
 
     JSON Example:
@@ -83,8 +131,16 @@ Multipart Messages
 
 .. autoclass:: OFPPortStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_stats_request.packet.json
+
 .. autoclass:: OFPPortStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_stats_reply.packet.json
+
 .. autoclass:: OFPPortDescStatsRequest
 
     JSON Example:
@@ -93,10 +149,22 @@ Multipart Messages
 
 .. autoclass:: OFPPortDescStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_desc_reply.packet.json
+
 .. autoclass:: OFPQueueStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_stats_request.packet.json
+
 .. autoclass:: OFPQueueStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_stats_reply.packet.json
+
 .. autoclass:: OFPQueueDescStatsRequest
 
     JSON Example:
@@ -105,10 +173,22 @@ Multipart Messages
 
 .. autoclass:: OFPQueueDescStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-queue_desc_reply.packet.json
+
 .. autoclass:: OFPGroupStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_stats_request.packet.json
+
 .. autoclass:: OFPGroupStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_stats_reply.packet.json
+
 .. autoclass:: OFPGroupDescStatsRequest
 
     JSON Example:
@@ -123,20 +203,52 @@ Multipart Messages
 
 .. autoclass:: OFPGroupFeaturesStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_features_request.packet.json
+
 .. autoclass:: OFPGroupFeaturesStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-group_features_reply.packet.json
+
 .. autoclass:: OFPMeterStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_stats_request.packet.json
+
 .. autoclass:: OFPMeterStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_stats_reply.packet.json
+
 .. autoclass:: OFPMeterDescStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_desc_request.packet.json
+
 .. autoclass:: OFPMeterDescStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_desc_reply.packet.json
+
 .. autoclass:: OFPMeterFeaturesStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_features_request.packet.json
+
 .. autoclass:: OFPMeterFeaturesStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-meter_features_reply.packet.json
+
 .. autoclass:: OFPControllerStatusStatsRequest
 
     JSON Example:
@@ -151,12 +263,28 @@ Multipart Messages
 
 .. autoclass:: OFPTableStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_stats_request.packet.json
+
 .. autoclass:: OFPTableStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_stats_reply.packet.json
+
 .. autoclass:: OFPTableDescStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_desc_request.packet.json
+
 .. autoclass:: OFPTableDescStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_desc_reply.packet.json
+
 .. autoclass:: OFPTableFeaturesStatsRequest
 
     JSON Example:
@@ -171,8 +299,16 @@ Multipart Messages
 
 .. autoclass:: OFPFlowMonitorRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_monitor_request.packet.json
+
 .. autoclass:: OFPFlowMonitorReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-flow_monitor_reply.packet.json
+
 .. autoclass:: OFPBundleFeaturesStatsRequest
 
     JSON Example:
@@ -187,8 +323,16 @@ Multipart Messages
 
 .. autoclass:: OFPExperimenterStatsRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-experimenter_request.packet.json
+
 .. autoclass:: OFPExperimenterStatsReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-experimenter_reply.packet.json
+
 Packet-Out Message
 ------------------
 
@@ -203,8 +347,16 @@ Barrier Message
 
 .. autoclass:: OFPBarrierRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-barrier_request.packet.json
+
 .. autoclass:: OFPBarrierReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-barrier_reply.packet.json
+
 Role Request Message
 --------------------
 
@@ -240,10 +392,22 @@ Set Asynchronous Configuration Message
 
 .. autoclass:: OFPSetAsync
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-set_async.packet.json
+
 .. autoclass:: OFPGetAsyncRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_async_request.packet.json
+
 .. autoclass:: OFPGetAsyncReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-get_async_reply.packet.json
+
 Asynchronous Messages
 =====================
 
@@ -270,21 +434,37 @@ Port Status Message
 
 .. autoclass:: OFPPortStatus
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-port_status.packet.json
+
 Controller Role Status Message
 ------------------------------
 
 .. autoclass:: OFPRoleStatus
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-role_status.packet.json
+
 Table Status Message
 --------------------
 
 .. autoclass:: OFPTableStatus
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-table_status.packet.json
+
 Request Forward Message
 -----------------------
 
 .. autoclass:: OFPRequestForward
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-requestforward.packet.json
+
 Controller Status Message
 -------------------------
 
@@ -302,6 +482,10 @@ Hello
 
 .. autoclass:: OFPHello
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-hello.packet.json
+
 .. autoclass:: OFPHelloElemVersionBitmap
 
 Echo Request
@@ -309,21 +493,37 @@ Echo Request
 
 .. autoclass:: OFPEchoRequest
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-echo_request.packet.json
+
 Echo Reply
 ----------
 
 .. autoclass:: OFPEchoReply
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-echo_reply.packet.json
+
 Error Message
 -------------
 
 .. autoclass:: OFPErrorMsg
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-error_msg.packet.json
+
 Experimenter
 ------------
 
 .. autoclass:: OFPExperimenter
 
+    JSON Example:
+
+    .. literalinclude:: ../../ryu/tests/unit/ofproto/json/of15/libofproto-OFP15-error_msg_experimenter.packet.json
+
 Flow Match Structure
 ====================