From 2059ad86a6013c21e78477f1ae5ae689e88f5010 Mon Sep 17 00:00:00 2001 From: Sachin Bansal Date: Thu, 15 Sep 2016 17:00:37 -0700 Subject: [PATCH] Generate html documenation from openapi.rst Generate html documentation for all REST APIs from contrail_openapi.rst file that is being generated froms schema. Also fixed few other minor issues. Change-Id: I5411e9da7a01c91783a206024d890f88eb74884f Partial-Bug: 1621664 --- src/config/api-server/doc/SConscript | 7 ++++--- src/config/api-server/doc/source/index.rst | 3 ++- src/config/api-server/vnc_cfg_ifmap.py | 11 ++--------- src/schema/ietf-l3vpn-schema.xsd | 2 +- 4 files changed, 9 insertions(+), 14 deletions(-) diff --git a/src/config/api-server/doc/SConscript b/src/config/api-server/doc/SConscript index 2a2afd7eea0..b8aef41e116 100644 --- a/src/config/api-server/doc/SConscript +++ b/src/config/api-server/doc/SConscript @@ -12,17 +12,18 @@ import shutil doc_sources_rules = [] -generated = ['vnc_cfg_api_server.rst', 'modules.rst'] +sphinxapidocs = ['vnc_cfg_api_server.rst', 'modules.rst'] if os.path.exists('/usr/bin/sphinx-apidoc'): - apidoc_rule = env.Command(generated, '', 'SPHINX_APIDOC_OPTIONS="members,show-inheritance" sphinx-apidoc -f -o ' + Dir('.').path + ' ' + Dir('../vnc_cfg_api_server').path + ' ' + Dir('.').path) + apidoc_rule = env.Command(sphinxapidocs, '', 'SPHINX_APIDOC_OPTIONS="members,show-inheritance" sphinx-apidoc -f -o ' + Dir('.').path + ' ' + Dir('../vnc_cfg_api_server').path + ' ' + Dir('.').path) env.Depends(apidoc_rule, File(env['TOP'] + '/config/api-server/vnc_cfg_api_server/gen/__init__.py')) userdoc_rule = env.Install(Dir('.'), Glob('#controller/src/config/api-server/doc/source/*')) schema_rule = env.Install(Dir('.'), Glob('#controller/src/schema/*.xsd')) + gendoc_rule = env.Install(Dir('.'), env['TOP'] + '/config/api-server/vnc_cfg_api_server/gen/contrail_openapi.rst') html_gen_rule = env.Command('contrail-config', ['Makefile', 'conf.py'], 'make -C ' + Dir('.').path + ' html') - env.Depends(html_gen_rule, [apidoc_rule, userdoc_rule, schema_rule]) + env.Depends(html_gen_rule, [apidoc_rule, gendoc_rule, userdoc_rule, schema_rule]) doc_sources_rules.append(env.Install("../vnc_cfg_api_server", Dir('.'))) diff --git a/src/config/api-server/doc/source/index.rst b/src/config/api-server/doc/source/index.rst index 2081ac45213..b277150df9e 100644 --- a/src/config/api-server/doc/source/index.rst +++ b/src/config/api-server/doc/source/index.rst @@ -36,13 +36,14 @@ This document provides: * Reference to the package, module and classes involved .. toctree:: - :maxdepth: 5 + :maxdepth: 3 tutorial_with_rest.rst tutorial_with_library.rst rest_details.rst library_details.rst library_reference.rst + contrail_openapi.rst .. modules.rst Indices and tables diff --git a/src/config/api-server/vnc_cfg_ifmap.py b/src/config/api-server/vnc_cfg_ifmap.py index ddcb43eecfa..6a600ce354f 100644 --- a/src/config/api-server/vnc_cfg_ifmap.py +++ b/src/config/api-server/vnc_cfg_ifmap.py @@ -18,7 +18,7 @@ import StringIO import socket -from netaddr import IPNetwork, IPAddress, IPSet +from netaddr import IPNetwork, IPAddress from cfgm_common.uve.vnc_api.ttypes import * from cfgm_common import ignore_exceptions @@ -37,7 +37,6 @@ from cfgm_common import vnc_greenlets from cfgm_common import SGID_MIN_ALLOC - import copy from cfgm_common import jsonutils as json import uuid @@ -50,8 +49,6 @@ import signal, os - -#from cfgm_common import vnc_type_conv from provision_defaults import * import cfgm_common.imid from cfgm_common.exceptions import * @@ -64,9 +61,6 @@ from sandesh.traces.ttypes import DBRequestTrace, MessageBusNotifyTrace, \ IfmapTrace -import logging -logger = logging.getLogger(__name__) - @ignore_exceptions def get_trace_id(): try: @@ -102,7 +96,6 @@ class VncIfmapClient(object): # to IfMap. # * In some properties, not all fields are relevant # to be publised to IfMap. - # If the property is not relevant at all, define the property # with None. If it is partially relevant, then define the fn. # which would handcraft the generated xml for the object. @@ -1639,7 +1632,7 @@ def iip_update_subnet_uuid(self, iip_dict): pfx_len = subnet['subnet']['ip_prefix_len'] cidr = '%s/%s' % (pfx, pfx_len) if (IPAddress(iip_dict['instance_ip_address']) in - IPSet([cidr])): + IPNetwork(cidr)): iip_dict['subnet_uuid'] = subnet['subnet_uuid'] self._cassandra_db.object_update('instance-ip', iip_dict['uuid'], diff --git a/src/schema/ietf-l3vpn-schema.xsd b/src/schema/ietf-l3vpn-schema.xsd index d0f1f4ecc75..00f6e7c690f 100644 --- a/src/schema/ietf-l3vpn-schema.xsd +++ b/src/schema/ietf-l3vpn-schema.xsd @@ -22,7 +22,7 @@ targetNamespace="http://www.contrailsystems.com/2012/BGP-CONFIG/0"> - +