From 7cbb1754e5a4499858712d2891d41f9eb1db7cb0 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Wed, 3 May 2023 10:35:46 +0200 Subject: [PATCH] Regenerated doc --- gcube-model-consistsof.rst | 2 -- gcube-model-facet.rst | 36 +++++++++++++++++------------------- gcube-model-resource.rst | 32 +++++++++++++++----------------- 3 files changed, 32 insertions(+), 38 deletions(-) diff --git a/gcube-model-consistsof.rst b/gcube-model-consistsof.rst index b3ee2c6..0d19c40 100644 --- a/gcube-model-consistsof.rst +++ b/gcube-model-consistsof.rst @@ -136,8 +136,6 @@ HasContact is a base relation type to capture the diverse points of contact asso +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. | - +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Dataset | HasContact | 1..n | ContactFacet | The contact information of the entity responsible for the dataset. | +------------------------------------------------------+--------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Schema | HasContact | 1..n | ContactFacet | | diff --git a/gcube-model-facet.rst b/gcube-model-facet.rst index 23e1756..fb3b058 100644 --- a/gcube-model-facet.rst +++ b/gcube-model-facet.rst @@ -180,8 +180,6 @@ ContactFacet captures information on a point of contact for the resource, i.e., +-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | +-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ - | Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. | - +-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. | +-----------------+----------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | ConcreteDataset | HasMaintainer | 1..n | ContactFacet | The contact information of the entity responsible for the maintenance of the concrete dataset | @@ -553,23 +551,23 @@ ProvenanceFacet captures information on provenance/lineage of the entire resourc .. table:: **ProvenanceFacet** ``extends`` **Facet** - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | Properties | - +=================+==============+======================================================================================================+======================================================================+====================================================+ - | **Name** | **Type** | **Attributes** | **Description** | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The ID of the referenced resource. | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | **Known Usage** | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ - | Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. | - +-----------------+--------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------+ + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | Properties | + +=================+==============+======================================================================================================+===========================================================================================================================================================================================================================================+====================================================+ + | **Name** | **Type** | **Attributes** | **Description** | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | document | ValueSchema | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | Provenance Document, e.g., an XML according to the reference schema. | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | reference | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` | The ID of the referenced resource. | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | relationship | String | ``Mandatory:false`` ``ReadOnly:false`` ``NotNull:false`` ``Regex:^(wasDerivedFrom|wasGeneratedBy)$`` | Relationship with the resource indicated by ID. Please note that the provenance has not been modelled as IsRelatedTo specialization, because the source resource is not necessarly in the IS or could be deleted from the IS at any time. | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | **Known Usage** | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | **Source** | **Relation** | **Multiplicity** | **Target** | **Description** | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ + | Dataset | ConsistsOf | 0..n | ProvenanceFacet | Any provenance record associated with the dataset. | + +-----------------+--------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ The **ProvenanceFacet** current version is 1.0.0. diff --git a/gcube-model-resource.rst b/gcube-model-resource.rst index 5a193c2..f044d47 100644 --- a/gcube-model-resource.rst +++ b/gcube-model-resource.rst @@ -39,23 +39,21 @@ Actor (Abstract) is any entity (human or machine) playing an active role in the .. table:: **Actor** ``extends`` **GCubeResource** - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Source | Relation | Multiplicity | Target | Description | - +========================+================+==============+=======================+=======================================================================================+ - | **Facets** | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Actor | ConsistsOf | 0..n | ContactReferenceFacet | | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Actor | HasContact | 0..n | ContactFacet | An Actor can have other Contact Facets which provide secondary contact information. | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | **Resource Relations** | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Dataset | Involves | 0..n | Actor | | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ - | Site | IsOwnedBy | 0..n | Actor | | - +------------------------+----------------+--------------+-----------------------+---------------------------------------------------------------------------------------+ + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | Source | Relation | Multiplicity | Target | Description | + +========================+================+==============+=======================+====================================================================================+ + | **Facets** | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | Actor | ConsistsOf | 0..n | ContactReferenceFacet | | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | Actor | IsIdentifiedBy | 1..1 | ContactFacet | An Actor has at least a Contact Facet which permit to identify the Actor per se. | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | **Resource Relations** | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | Dataset | Involves | 0..n | Actor | | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ + | Site | IsOwnedBy | 0..n | Actor | | + +------------------------+----------------+--------------+-----------------------+------------------------------------------------------------------------------------+ The **Actor** current version is 1.0.0.