Merge pull request #200 from GenomicDataInfrastructure/healthdcat-fields-in-retrieveddataset

feat(dataset): add HealthDCAT fields to RetrievedDataset and update m…

Author: hcvdwerf

src/main/openapi/ckan.yaml

@@ -250,6 +250,110 @@ components:
             $ref: "#/components/schemas/CkanResource"
         dcat_type:
           $ref: "#/components/schemas/CkanValueLabel"
+
+        # Below are properties from HealthDCAT
+        publisher_note:
+          type: array
+          items:
+            type: string
+        publisher_coverage:
+          type: array
+          items:
+            type: string
+        publisher_type:
+          type: array
+          items:
+            type: string
+        trusted_data_holder:
+          type: boolean
+        hdab:
+          type: array
+          items:
+            $ref: "#/components/schemas/CkanAgent"
+        spatial_coverage:
+          type: array
+          description: A geographic region that is covered by the dataset.
+          items:
+            $ref: '#/components/schemas/CkanSpatialCoverage'
+        spatial_resolution_in_meters:
+          type: number
+          format: float
+          description: Minimum spatial separation resolvable in a dataset, measured in meters.
+        temporal_coverage:
+          type: array
+          items:
+            $ref: "#/components/schemas/CkanTimeWindow"
+        temporal_resolution:
+          type: string
+        population_coverage:
+          type: array
+          items:
+            type: string
+        retention_period:
+          type: array
+          items:
+            $ref: "#/components/schemas/CkanTimeWindow"
+        purpose:
+          type: array
+          items:
+            type: string
+        legal_basis:
+          type: array
+          items:
+            type: string
+        applicable_legislation:
+          type: array
+          items:
+            type: string
+        health_theme:
+          type: array
+          items:
+            type: string
+        health_category:
+          type: array
+          items:
+            type: string
+        max_typical_age:
+          type: integer
+        min_typical_age:
+          type: integer
+        number_of_records:
+          type: integer
+        number_of_unique_individuals:
+          type: integer
+        analytics:
+          type: array
+          items:
+            type: string
+        code_values:
+          type: array
+          items:
+            type: string
+        coding_system:
+          type: array
+          items:
+            type: string
+        alternate_identifier:
+          type: array
+          items:
+            type: string
+        version_notes:
+          type: string
+        qualified_relation:
+          type: array
+          items:
+            type: object
+            properties:
+              relation:
+                type: string
+              role:
+                type: string
+              uri:
+                type: string
+        personal_data:
+          type: array
+          items:
+            type: string
       required:
         - id
         - title
@@ -393,3 +497,28 @@ components:
       required:
         - name
         - display_name
+    CkanTimeWindow:
+      properties:
+        start:
+          type: string
+        end:
+          type: string
+    CkanSpatialCoverage:
+      type: object
+      properties:
+        uri:
+          type: string
+          description: URI
+        text:
+          type: string
+          description: Label
+        geom:
+          type: string
+          description: Geometry
+        bbox:
+          type: string
+          description: Bounding Box
+        centroid:
+          type: string
+          description: Centroid
+

src/main/openapi/discovery.yaml

@@ -450,6 +450,109 @@ components:
           title: Distributions
         dcatType:
           $ref: "#/components/schemas/ValueLabel"
+        # Below are properties from HealthDCAT
+        publisherNote:
+          type: array
+          items:
+            type: string
+        publisherCoverage:
+          type: array
+          items:
+            type: string
+        publisherType:
+          type: array
+          items:
+            type: string
+        trustedDataHolder:
+          type: boolean
+        hdab:
+          type: array
+          items:
+            $ref: "#/components/schemas/Agent"
+        spatialCoverage:
+          type: array
+          description: A geographic region that is covered by the dataset.
+          items:
+            $ref: '#/components/schemas/SpatialCoverage'
+        spatialResolutionInMeters:
+          type: number
+          format: float
+          description: Minimum spatial separation resolvable in a dataset, measured in meters.
+        temporalCoverage:
+          type: array
+          items:
+            $ref: "#/components/schemas/TimeWindow"
+        temporalResolution:
+          type: string
+        populationCoverage:
+          type: array
+          items:
+            type: string
+        retentionPeriod:
+          type: array
+          items:
+            $ref: "#/components/schemas/TimeWindow"
+        purpose:
+          type: array
+          items:
+            type: string
+        legalBasis:
+          type: array
+          items:
+            type: string
+        applicableLegislation:
+          type: array
+          items:
+            type: string
+        healthTheme:
+          type: array
+          items:
+            type: string
+        healthCategory:
+          type: array
+          items:
+            type: string
+        maxTypicalAge:
+          type: integer
+        minTypicalAge:
+          type: integer
+        numberOfRecords:
+          type: integer
+        numberOfUniqueIndividuals:
+          type: integer
+        analytics:
+          type: array
+          items:
+            type: string
+        codeValues:
+          type: array
+          items:
+            type: string
+        codingSystem:
+          type: array
+          items:
+            type: string
+        alternateIdentifier:
+          type: array
+          items:
+            type: string
+        versionNotes:
+          type: string
+        qualifiedRelation:
+          type: array
+          items:
+            type: object
+            properties:
+              relation:
+                type: string
+              role:
+                type: string
+              uri:
+                type: string
+        personalData:
+          type: array
+          items:
+            type: string
       required:
         - id
         - title
@@ -566,6 +669,32 @@ components:
         - name
         - type
         - description
+    TimeWindow:
+      properties:
+        start:
+          type: string
+          format: date-time
+        end:
+          type: string
+          format: date-time
+    SpatialCoverage:
+      type: object
+      properties:
+        uri:
+          type: string
+          description: URI
+        text:
+          type: string
+          description: Label
+        geom:
+          type: string
+          description: Geometry
+        bbox:
+          type: string
+          description: Bounding Box
+        centroid:
+          type: string
+          description: Centroid
     Filter:
       properties:
         source: