Merge pull request #5 from FAIR-IMPACT/SemanticArtefactDistribution

Refactoring and the addition of the SemanticArtefactDistribution

README.md

@@ -2,9 +2,9 @@
 
 # MOD-FAIRsFAIR-Profile based on OGC Building Block template
 
-This repository provides a representation of the MOD FAIRsFAIR Profile based on the OGC Building Block template.
+This repository provides a representation of the FAIRsFAIR Profile of the SemanticArtefact and SemanticArtefactDistribution from the MOD ontology based on the OGC Building Block template.
 
-The FAIRsFAIR MOD profile is defined by considering the results in the vote organised within a FAIRsFAIR workshop for the endorsement level mandatory-recommended-optional for each property to describe a semantic artefact, as reported in the publication:
+The FAIRsFAIR Profile of the SemanticArtefact from the MOD ontology is defined by considering the results in the vote organised within a FAIRsFAIR workshop for the endorsement level mandatory-recommended-optional for each property to describe a semantic artefact, as reported in the publication:
 
     - Clement Jonquet, Biswanath Dutta, Luiz O. Bonino da Silva Santos, Robert Pergl, Yann Le Franc. Common Minimum Metadata for FAIR Semantic Artefacts. 2nd Workshop on Ontologies for FAIR and FAIR Ontologies (Onto4FAIR 2023), C. Trojahn; L. O. Bonino da Silva Santos; G. Guizzardi; C. Jonquet, Jul 2023, Sherbrooke, Canada. ⟨[hal-04106533v2](https://hal.science/hal-04106533/)⟩
 
@@ -17,10 +17,9 @@ To create the FAIRsFAIR MOD profile, we considered as required those properties
 
 The OGC Building Block template produces:
 
-- [MOD-FAIRsFAIR-Profile Documentation](https://fair-impact.github.io/MOD-FAIRsFAIR-profile/build/generateddocs/slate-build/bbr/template/mod-fairsfair-bblock/): documentation about the profile
-
-- [MOD-FAIRsFAIR-Profile Test reports](https://fair-impact.github.io/MOD-FAIRsFAIR-profile/build/tests/report.html): tests reports for the test files available at https://github.com/FAIR-IMPACT/MOD-FAIRsFAIR-profile/tree/master/_sources/mod-fairsfair-bblock/tests
+- MOD-FAIRsFAIR-Profile documentation for the [SemanticArtefact](https://fair-impact.github.io/MOD-FAIRsFAIR-profile/build/generateddocs/slate-build/bbr/template/mod-fairsfair-semanticartefact/) and [SemanticArtefactDistribution](https://fair-impact.github.io/MOD-FAIRsFAIR-profile/build/generateddocs/slate-build/bbr/template/mod-fairsfair-semanticartefactdistribution/)
 
+- MOD-FAIRsFAIR-Profile [Test reports](https://fair-impact.github.io/MOD-FAIRsFAIR-profile/build/tests/report.html)
 
 More information on the OGC approach can be found:
 - [Building Blocks](https://blocks.ogc.org/)

_sources/mod-fairsfair-bblock/bblock.json → _sources/mod-fairsfair-semanticartefact/bblock.json

@@ -1,18 +1,18 @@
 {
   "$schema": "metaschema.yaml",
-  "name": "MOD-FAIRsFAIR-Profile",
-  "abstract": "This Building Block is the FAIRsFAIR Profile for the MOD ontology",
+  "name": "MOD FAIRsFAIR SemanticArtefact Profile",
+  "abstract": "This Building Block is the FAIRsFAIR Profile of the SemanticArtefact from the MOD ontology",
   "status": "under-development",
   "dateTimeAddition": "2023-04-05T00:00:00Z",
   "itemClass": "schema",
   "register": "ogc-building-block-register",
   "version": "0.1",
   "dateOfLastChange": "2023-04-05",
-  "link": "https://github.com/opengeospatial/bblock-template",
+  "link": "https://github.com/FAIR-IMPACT/MOD-FAIRsFAIR-profile/",
   "sources": [
     {
-      "title": "Sample source document",
-      "link": "https://example.com/sources/1"
+      "title": "MOD Ontology",
+      "link": "https://github.com/fair-IMPACT/mod"
     }
   ],
   "maturity": "mature",

_sources/mod-fairsfair-semanticartefact/description.md

@@ -0,0 +1,3 @@
+## MOD FAIRsFAIR Semantic Artefact Profile
+
+This is the representation of the FAIRsFAIR Profile of the SemanticArtefact from the MOD ontology. This document provides a human-readable description of the profile.

_sources/mod-fairsfair-semanticartefact/examples.yaml

@@ -0,0 +1,11 @@
+- title: Examples of MOD Semantic Artefact description complying with the FAIRsFAIR profile.
+  content: |-
+    These examples show the minimum feature set as well as a full feature set.
+    
+  snippets:
+    - language: json
+      ref: examples/example-basic.json
+      schema-ref: "#/$defs/mod:SemanticArtefact"
+    - language: json
+      ref: examples/example-full.json
+      schema-ref: "#/$defs/mod:SemanticArtefact"

_sources/mod-fairsfair-semanticartefact/schema.yaml

@@ -0,0 +1,75 @@
+"$schema": https://json-schema.org/draft/2020-12/schema
+description: 'Schema for the MOD FAIRsFAIR SemanticArtefact Profile'
+$defs:
+    mod:SemanticArtefact:
+        allOf:
+            - type: object
+              properties:
+                dcat:keyword:
+                    type: string
+                dcat:landingPage:
+                    type: string
+                    format: URI
+                dct:accessRights:
+                    type: string
+                dct:accrualMethod:
+                    type: string
+                dct:accrualPeriodicity:
+                    type: string
+                dct:contributor:
+                    type: string
+                dct:created:
+                    type: string
+                dct:creator:
+                    type: string
+                dct:description:
+                    type: string
+                dct:identifier:
+                    type: string
+                dct:language:
+                    type: string
+                dct:license:
+                    type: string
+                dct:modified:
+                    type: string
+                dct:publisher:
+                    type: string
+                dct:relation:
+                    type: string
+                dct:subject:
+                    type: string
+                dct:title:
+                    type: string
+                dct:type:
+                    type: string
+                mod:acronym:
+                    type: string
+                mod:competencyQuestion:
+                    type: string
+                mod:hasFormalityLevel:
+                    type: string
+                mod:status:
+                    type: string
+                mod:URI:
+                    type: string
+                    format: URI
+                mod:usedEngineeringMethodology:
+                    type: string
+                owl:versionIRI:
+                    type: string
+                prov:wasGeneratedBy:
+                    type: string
+                schema:includedInDataCatalog:
+                    type: string
+
+              required:
+                - dct:title
+                - dct:license
+                - dct:identifier
+                - dct:accessRights
+                - dct:creator
+                - dct:created
+                - dct:description
+
+anyOf:
+  - $ref: "#/$defs/mod:SemanticArtefact"

_sources/mod-fairsfair-semanticartefactdistribution/bblock.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "metaschema.yaml",
+  "name": "MOD FAIRsFAIR SemanticArtefactDistribution Profile",
+  "abstract": "This Building Block is the FAIRsFAIR Profile of the SemanticArtefactDistribution from the MOD ontology",
+  "status": "under-development",
+  "dateTimeAddition": "2023-04-05T00:00:00Z",
+  "itemClass": "schema",
+  "register": "ogc-building-block-register",
+  "version": "0.1",
+  "dateOfLastChange": "2023-04-05",
+  "link": "https://github.com/FAIR-IMPACT/MOD-FAIRsFAIR-profile/",
+  "sources": [
+    {
+      "title": "MOD Ontology",
+      "link": "https://github.com/fair-IMPACT/mod"
+    }
+  ],
+  "maturity": "mature",
+  "scope": "unstable",
+  "tags": ["templates"]
+}

_sources/mod-fairsfair-semanticartefactdistribution/context.jsonld

@@ -0,0 +1,13 @@
+{
+  "@context": {
+    "dcat": "http://www.w3.org/ns/dca#",
+    "dct": "http://purl.org/dc/terms/",
+    "mod": "https://w3id.org/mod#",
+    "owl": "http://www.w3.org/2002/07/owl#",
+    "prov": "http://www.w3.org/ns/prov#",
+    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+    "schema": "https://schema.org/",
+    "xsd": "http://www.w3.org/2001/XMLSchema#"
+  }
+}

_sources/mod-fairsfair-semanticartefactdistribution/description.md

@@ -0,0 +1,3 @@
+## MOD FAIRsFAIR Semantic Artefact Distribution Profile
+
+This is the representation of the FAIRsFAIR Profile of the SemanticArtefactDistribution from the MOD ontology. This document provides a human-readable description of the profile.

_sources/mod-fairsfair-semanticartefactdistribution/examples.yaml

@@ -0,0 +1,8 @@
+- title: Examples of MOD Semantic Artefact Distribution description complying with the FAIRsFAIR profile.
+  content: |-
+    This example shows a full feature set.
+    
+  snippets:
+    - language: json
+      ref: examples/example.json
+      schema-ref: "#/$defs/mod:SemanticArtefactDistribution"

_sources/mod-fairsfair-semanticartefactdistribution/examples/example.json

@@ -0,0 +1,29 @@
+{
+    "dcat:keyword": "keyword",
+    "dcat:landingPage": "https://example.org/",
+    "dct:accessRights": "all",
+    "dct:accrualMethod": "accrual method",
+    "dct:accrualPeriodicity": "1 year",
+    "dct:contributor": "me",
+    "dct:created": "2024",
+    "dct:creator": "me",
+    "dct:description": "my semantic artefact is ....",
+    "dct:identifier": "mySA",
+    "dct:language": "English",
+    "dct:license": "our license",
+    "dct:modified": "2024",
+    "dct:publisher": "2024",
+    "dct:relation": "schema:keywords",
+    "dct:subject": "semantic artefacts",
+    "dct:title": "my semantic artefact",
+    "dct:type": "semantic artefact",
+    "mod:acronym": "mySA",
+    "mod:competencyQuestion": "A set of questions made to build an ontology at the design time.",
+    "mod:hasFormalityLevel": "1",
+    "mod:status": "prime",
+    "mod:URI": "https://example.org/",
+    "mod:usedEngineeringMethodology": "snap",
+    "owl:versionIRI": "https://w3id.org/modp/2.0",
+    "prov:wasGeneratedBy": "me",
+    "schema:includedInDataCatalog": "none"
+}

_sources/mod-fairsfair-semanticartefactdistribution/schema.yaml

@@ -0,0 +1,48 @@
+"$schema": https://json-schema.org/draft/2020-12/schema
+description: 'Schema for the MOD FAIRsFAIR SemanticArtefactDistribution Profile'
+$defs:
+    mod:SemanticArtefactDistribution:
+        allOf:
+            - type: object
+              properties:
+                dcat:accessURL:
+                    type: string
+                    format: URI
+                dcat:byteSize:
+                    type: string
+                dcat:downloadURL:
+                    type: string
+                    format: URI
+                dct:accessRights:
+                    type: string
+                dct:description:
+                    type: string
+                dct:modified:
+                    type: string
+                dct:title:
+                    type: string
+                mod:authorProperty:
+                    type: string
+                mod:definitionProperty:
+                    type: string
+                mod:hasRepresentationLanguage:
+                    type: string
+                mod:hasSyntax:
+                    type: string
+                mod:hierarchyProperty:
+                    type: string
+                mod:metrics:
+                    type: string
+                mod:obsoleteParent:
+                    type: string
+                mod:obsoleteProperty:
+                    type: string
+                mod:prefLabelProperty:
+                    type: string
+                mod:sampleQueries:
+                    type: string
+                mod:synonymProperty:
+                    type: string
+
+anyOf:
+  - $ref: "#/$defs/mod:SemanticArtefactDistribution"