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

Updated documentation via doc generator

This commit is contained in:
Luca Frosini 2023-05-02 18:06:26 +02:00
parent 2808053ae6
commit 28e77ae074
1 changed files with 33 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -291,23 +291,23 @@ DescriptiveMetadataFacet captures information on descriptive metadata to be asso
.. table:: **DescriptiveMetadataFacet** ``extends`` **Facet** .. table:: **DescriptiveMetadataFacet** ``extends`` **Facet**
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Properties | | Properties |
+=================+==============+========================================================+=================================================================================+=======================================================================================+ +=====================+==============+========================================================+=================================================================================+=======================================================================================+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| metadata | ValueSchema | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | A metadata record representing the descriptive metadata according to the schema | | descriptiveMetadata | ValueSchema | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | A metadata record representing the descriptive metadata according to the schema |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| **Known Usage** | | **Known Usage** |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Dataset | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the dataset, e.g. for discovery purposes. | | Dataset | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the dataset, e.g. for discovery purposes. |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Schema | ConsistsOf | 0..n | DescriptiveMetadataFacet | | | Schema | ConsistsOf | 0..n | DescriptiveMetadataFacet | |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| Service | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the service, e.g. for discovery purposes. | | Service | ConsistsOf | 0..n | DescriptiveMetadataFacet | Any descriptive information associated with the service, e.g. for discovery purposes. |
+-----------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ +---------------------+--------------+--------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
The **DescriptiveMetadataFacet** current version is 1.0.0. The **DescriptiveMetadataFacet** current version is 1.0.0.
@ -368,7 +368,7 @@ IdentifierFacet captures information on identifiers (other than the ones automat
+=======================+================+======================================================================================================+=========================================================+==============================================================+ +=======================+================+======================================================================================================+=========================================================+==============================================================+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ +-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+
| type | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^(URI|DOI|IRI|URL|URN|UUID|STRING)$`` | The typology of identifier | | identificationType | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` ``Regex:^(URI|DOI|IRI|URL|URN|UUID|STRING)$`` | The typology of identifier |
+-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ +-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+
| value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The identifier | | value | String | ``Mandatory:true`` ``ReadOnly:false`` ``NotNull:true`` | The identifier |
+-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+ +-----------------------+----------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------+--------------------------------------------------------------+
@ -553,23 +553,21 @@ ProvenanceFacet captures information on provenance/lineage of the entire resourc
.. table:: **ProvenanceFacet** ``extends`` **Facet** .. table:: **ProvenanceFacet** ``extends`` **Facet**
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| Properties | | Properties |
+=================+==============+=======================================================================================================================================================+======================================================================+====================================================+ +=================+==============+======================================================================================================+======================================================================+====================================================+
| **Name** | **Type** | **Attributes** | **Description** | | **Name** | **Type** | **Attributes** | **Description** |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by UUID. | | relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}$`` | UUID of the referenced resource. | | document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. | | **Known Usage** |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| **Known Usage** | | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | | Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
| Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. |
+-----------------+--------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+
The **ProvenanceFacet** current version is 1.0.0. The **ProvenanceFacet** current version is 1.0.0.