From e81b78f1527ef77484e6256838298de008ca4d8b Mon Sep 17 00:00:00 2001 From: Alexander Vorkov Date: Thu, 11 Nov 2021 23:34:51 +0200 Subject: [PATCH 1/3] fix yaml error TypeError: load() missing 1 required positional argument: 'Loader' --- docs/generator.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/generator.py b/docs/generator.py index c75786e2..d4369f1b 100644 --- a/docs/generator.py +++ b/docs/generator.py @@ -249,7 +249,7 @@ def generate_doc_files(self, dest_dir): module_name = os.path.splitext(module_filename)[0] module = importlib.import_module(module_name) - module_docs = yaml.load(module.DOCUMENTATION) + module_docs = yaml.load(module.DOCUMENTATION, Loader=yaml.FullLoader) module_spec = ModuleSpec( name=module_name, short_description=self._doc_to_text(module_docs.get('short_description')), From ca013f5361a1fb089819df642f269f30de3b0f77 Mon Sep 17 00:00:00 2001 From: Alexander Vorkov Date: Thu, 11 Nov 2021 23:42:41 +0200 Subject: [PATCH 2/3] Fix yaml.load issue --- docs/generator.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/generator.py b/docs/generator.py index d4369f1b..b88b8bf4 100644 --- a/docs/generator.py +++ b/docs/generator.py @@ -270,7 +270,7 @@ def _doc_to_text(text): @staticmethod def _get_module_params(module): - docs = yaml.load(module.DOCUMENTATION) + docs = yaml.load(module.DOCUMENTATION, Loader=yaml.FullLoader) return {k: { 'description': ModuleDocGenerator._doc_to_text(v.get('description')), 'required': v.get('required', False), @@ -279,7 +279,7 @@ def _get_module_params(module): @staticmethod def _get_module_return_values(module): - return_params = yaml.load(module.RETURN) + return_params = yaml.load(module.RETURN, Loader=yaml.FullLoader) return {k: { 'description': ModuleDocGenerator._doc_to_text(v.get('description')), 'returned': v.get('returned', ''), From c2cb865cf6a1d6d4eb1e8c98ef65ef70be3ed603 Mon Sep 17 00:00:00 2001 From: Alexander Vorkov Date: Fri, 12 Nov 2021 09:54:42 +0200 Subject: [PATCH 3/3] fix bug with SSLGroupType for 7.1.0 --- docs/build.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build.py b/docs/build.py index 49b64fc4..66009613 100644 --- a/docs/build.py +++ b/docs/build.py @@ -208,7 +208,7 @@ def _generate_ansible_docs(args, api_spec, template_ctx): def _generate_ftd_api_docs(args, api_spec, template_ctx, errors_codes): - if template_ctx['ftd_version'] == '7.0.0': + if template_ctx['ftd_version'] == '7.0.0' or template_ctx['ftd_version'] == '7.1.0': # SSLGroupType has incorrect representation in 7.0.0 API spec, as it doesn't contain possible enum values. # We need to add these enum values here to generate docs and represent possible values. api_spec['models']['SSLGroupType']['enum'] = ["GROUP_14", "GROUP_15", "GROUP_19", "GROUP_20", "GROUP_21"]