aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichal Jagiello <michal.jagiello@t-mobile.pl>2022-02-09 12:30:27 +0000
committerMichal Jagiello <michal.jagiello@t-mobile.pl>2022-02-14 11:44:09 +0000
commita8e2a839a4cb65e341c610fd2bd2e8968c754b3d (patch)
tree766c9b0c52c0e392f2ab79d87498623d1c016b77 /docs
parent0384b57fa175d45f5c3947adb488ef572669bce1 (diff)
Custom YAML tag to get already existed ONAP resources properties
Would be useful for Alloted Resources Issue-ID: INT-2075 Signed-off-by: Michal Jagiello <michal.jagiello@t-mobile.pl> Change-Id: Iad398a2f0c049ba73fa4569a0f2caed1311f077c
Diffstat (limited to 'docs')
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/tags.rst33
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5cadde1..9360ed3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -12,6 +12,7 @@ Welcome to ONAP data provider's documentation!
description
schemas
+ tags
usage
diff --git a/docs/source/tags.rst b/docs/source/tags.rst
new file mode 100644
index 0000000..b16e83e
--- /dev/null
+++ b/docs/source/tags.rst
@@ -0,0 +1,33 @@
+ONAP data provider custom YAML tags
+===================================
+
+In ONAP data provider we created a few custom YAML tags which could be used (and useful) in entities files.
+
+!join tag
+---------
+
+Concatenate multiple strings in YAML value.
+
+`!join [a, b, c]` result is `abc`
+
+`!join ['_', [a, b, c]]` result is `a_b_c`
+
+!uuid4 tag
+----------
+
+Generates a random UUID4
+
+`!uuid4` result is random UUID4 value
+
+!onap_resource_property
+-----------------------
+
+Gets the property value from the already existing ONAP resources.
+
+Available resources:
+
+* SDC service
+
+`!onap_resource_property service identifier service-model-name` result is a SDC service "service-model-name" model "identifier" property value
+
+`!onap_resource_property service identifier service-model-name 1.0` result is a SDC service "service-model-name" version 1.0 model "identifier" property value