gCubeSystem
/
gcube-model
15
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

This commit is contained in:
Luca Frosini 2024-06-14 15:09:36 +02:00
parent d522fc7799
commit 909ce7a0b3
2 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/gcube-model-facet.rst
View File

@ -842,28 +842,30 @@ Changelog:
TemplateFacet
-------------
This facet define a template to instantiate using the list of attributes specified
This facet define a template for a Facet to instantiate using the list of attributes specified. The type of the instatianted facet is specified in 'targetFacetType' attribute
.. table:: **TemplateFacet** ``extends`` **Facet**
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| Properties |
+========================================+====================================================+========================================================+================================================================+=================+
+======================================================+====================================================+========================================================+================================================================+=================+
| **Name** | **Type** | **Attributes** | **Description** |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| attributes | List<:ref:`AttributeProperty <AttributeProperty>`> | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The attributes of the template to be created when instantiated |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| description | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The description of the template |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The name of template |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| name | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The name of the template |
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| targetFacetType | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The type of Facet to instantiate with the attributes valued |
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| **Known Usage** |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| No specific known usage for this type. |
+----------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
| :ref:`ConfigurationTemplate <ConfigurationTemplate>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`TemplateFacet <TemplateFacet>` | |
+------------------------------------------------------+----------------------------------------------------+--------------------------------------------------------+----------------------------------------------------------------+-----------------+
The **TemplateFacet** current version is 1.0.0.

2
docs/gcube-model-resource.rst
View File

@ -144,6 +144,8 @@ Configuration Template represents a template for a configuration. It describes h
+======================================================+========================================+==============+======================================================+========================================================================+
| **Facets** |
+------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`ConfigurationTemplate <ConfigurationTemplate>` | :ref:`ConsistsOf <ConsistsOf>` | 0..n | :ref:`TemplateFacet <TemplateFacet>` | |
+------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`ConfigurationTemplate <ConfigurationTemplate>` | :ref:`IsIdentifiedBy <IsIdentifiedBy>` | 1..1 | :ref:`IdentifierFacet <IdentifierFacet>` | |
+------------------------------------------------------+----------------------------------------+--------------+------------------------------------------------------+------------------------------------------------------------------------+
| **Resource Relations** |