Project Plan: JSON examples for ODL User Guides by Dhiraj Sharma

Goals

Add JSON, XML payloads for OPENFLOW, NETCONF, ODL Controller and look for their functionality with existing JSON, XML payloads.

Migrating Wiki contents of OPENFLOW, NETCONF, CONTROLLER, MDSAL, OPFLEX, YANGTOOLS, INTEGRATION, TEST, INFRAUTILS from https://wiki-archive.opendaylight.org/view/Main_Page to https://wiki.opendaylight.org/

Tasks

Deliverables

• OPENFLOW, NETCONF, ODL Controller documentation with JSON and XML Payloads 
• Migration of wiki pages of OPENFLOW, NETCONF, ODL Controller, MDSAL, OPFLEX, YANGTOOLS, INTEGRATION, TEST, INFRAUTILS from https://docs.opendaylight.org/en/stable-magnesium/ to https://wiki.opendaylight.org/

Implementation

• I have planned to use https://pypi.org/project/xmljson/ python package to convert XML to JSON for payloads which will create an error with ODL conversion.
• The converted payload can be tested on ODL controller for verification and accordingly changes will be done manually to the payload for further improvement, if it is not satisfactory.

Milestones

Week 6

•  Setting up mininet, ODL and understanding OPENFLOW
•  Adding JSON payloads along with XML payloads in OPENFLOW User Guide
•  Migrating wiki content of OPENFLOW documentation

Week 12

• Adding JSON payloads along with XML payloads in NETCONF User Guide
• Migrating wiki content of NETCONF documentation
• Adding JSON payloads along with XML payloads in CONTROLLER User Guide Partially

Week 18

•  Adding JSON payloads along with XML payloads in CONTROLLER User Guide Fully
•  Migrate wiki content of CONTROLLER
•  Migrate wiki content of INTEGRATION, TEST
•  Migrate wiki content of MDSAL

Week 24

•  Migrate wiki content of INFRAUTILS
•  Migrate wiki content of YANGTOOLS
•  To Be Discussed
•  Summary Report