diff options
| author |   Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl> | 2023-07-13 12:21:23 +0200 |
|---|---|---|
| committer | Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl> | 2023-07-24 15:42:55 +0200 |
| commit | 48f63ef8e43f789cc6d364d387df289094edfc25 (patch) | |
| tree | 7865d2785406d06559a3978da42d1107c4c11e96 /src/onapsdk | |
| parent | d39c14ca0b8ba9e187c7c9b27793a737e90c3337 (diff) | |
Add .readthedocs.yaml and fix the lingering errors
This commit started as plain adding of .readthedocs file
but to allow tests to pass we needed to perform some
doc/docstring fixes.
Issue-ID: INT-2260
Change-Id: Ib603b9aaad43bb8c55ff5c2c23cd9a1a29865de9
Signed-off-by: Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>
Diffstat (limited to 'src/onapsdk')
| -rw-r--r-- | src/onapsdk/cds/data_dictionary.py | 21 | ||||
| -rw-r--r-- | src/onapsdk/sdc/service.py | 4 | ||||
| -rw-r--r-- | src/onapsdk/sdc/vf.py | 2 |
3 files changed, 15 insertions, 12 deletions
diff --git a/src/onapsdk/cds/data_dictionary.py b/src/onapsdk/cds/data_dictionary.py index b4d8d0e..27cfc29 100644 --- a/src/onapsdk/cds/data_dictionary.py +++ b/src/onapsdk/cds/data_dictionary.py @@ -136,6 +136,7 @@ class DataDictionary(CdsElement): - "entry_schema" - "updatedBy" - "definition" + "definition" key value should contains the "raw" data dictionary. Returns: @@ -153,15 +154,17 @@ class DataDictionary(CdsElement): this kind of data dictionary can't be uploaded to blueprintprocessor. That method tries to fix it. It can be done only if "raw" data dictionary has a given schema: - { - "name": "string", - "tags": "string", - "updated-by": "string", - "property": { - "description": "string", - "type": "string" - } - } + + .. code-block: json: + { + "name": "string", + "tags": "string", + "updated-by": "string", + "property": { + "description": "string", + "type": "string" + } + } Raises: ValidationError: Data dictionary doesn't have all required keys diff --git a/src/onapsdk/sdc/service.py b/src/onapsdk/sdc/service.py index 44a26e8..507b068 100644 --- a/src/onapsdk/sdc/service.py +++ b/src/onapsdk/sdc/service.py @@ -406,8 +406,8 @@ class Service(SdcResource): # pylint: disable=too-many-instance-attributes, too Load VNFs from components generator. It creates a generator of the vf modules as well, but without - vf modules which has "vf_module_label" property value equal - to "base_template_dummy_ignore". + vf modules which has "vf_module_label" property value equal + to "base_template_dummy_ignore". Returns: Iterator[Vnf]: Vnf objects iterator diff --git a/src/onapsdk/sdc/vf.py b/src/onapsdk/sdc/vf.py index 7e4e4a7..3b979b5 100644 --- a/src/onapsdk/sdc/vf.py +++ b/src/onapsdk/sdc/vf.py @@ -72,7 +72,7 @@ class Vf(SdcResource): If Vf is created vendor is get from it's resource metadata. Otherwise it's vendor provided by the user or the vendor from vsp. It's possible that method returns None, but it won't be possible then - to create that Vf resource. + to create that Vf resource. Returns: Optional[Vendor]: Vendor object related with Vf |