@magda/registry-aspects 1.2.1-alpha.0 → 2.0.0-alpha.0

package/README.md

@@ -2,29 +2,29 @@
 
 This package includes all built-in [Magda](https://github.com/magda-io/magda) registry Aspects Json Schemas:
 
--   access.schema.json
--   ckan-dataset.schema.json
--   ckan-resource.schema.json
--   csv-dataset.schema.json
--   information-security.schema.json
--   csw-dataset.schema.json
--   organization-details.schema.json
--   csw-distribution.schema.json
--   currency.schema.json
--   project-open-data-dataset.schema.json
--   dap-dataset.schema.json
--   project-open-data-distribution.schema.json
--   dap-resource.schema.json
--   project.schema.json
--   dataset-access-control.schema.json
--   provenance.schema.json
--   dataset-distributions.schema.json
--   publishing.schema.json
--   dataset-format.schema.json
--   source-link-status.schema.json
--   dataset-linked-data-rating.schema.json
--   source.schema.json
--   dataset-publisher.schema.json
--   spatial-coverage.schema.json
--   dataset-quality-rating.schema.json
--   temporal-coverage.schema.json
+- access.schema.json
+- ckan-dataset.schema.json
+- ckan-resource.schema.json
+- csv-dataset.schema.json
+- information-security.schema.json
+- csw-dataset.schema.json
+- organization-details.schema.json
+- csw-distribution.schema.json
+- currency.schema.json
+- project-open-data-dataset.schema.json
+- dap-dataset.schema.json
+- project-open-data-distribution.schema.json
+- dap-resource.schema.json
+- project.schema.json
+- access-control.schema.json (previously `dataset-access-control` aspect)
+- provenance.schema.json
+- dataset-distributions.schema.json
+- publishing.schema.json
+- dataset-format.schema.json
+- source-link-status.schema.json
+- dataset-linked-data-rating.schema.json
+- source.schema.json
+- dataset-publisher.schema.json
+- spatial-coverage.schema.json
+- dataset-quality-rating.schema.json
+- temporal-coverage.schema.json

package/{dataset-access-control.schema.json → access-control.schema.json}

@@ -1,7 +1,7 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "Access Control information of a dataset",
-    "description": "Access Control information of a dataset. Including: ownership information and pre-authorised permissions",
+    "title": "Access Control Aspect",
+    "description": "Access Control information of a dataset or other registry records. Including: ownership information and pre-authorised permissions. Previously named `dataset-access-control` for legacy reasons, this aspect can actually be used for any registry records.",
     "type": "object",
     "properties": {
         "ownerId": {

package/ckan-dataset.schema.json

@@ -1,5 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a dataset according to CKAN",
+    "title": "CKAN Dataset Aspect",
+    "description": "Aspect capturing a complete representation of a dataset according to CKAN",
     "type": "object"
 }

package/ckan-resource.schema.json

@@ -1,5 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a resource according to CKAN",
+    "title": "CKAN Resource Aspect",
+    "description": "Aspect capturing a complete representation of a resource according to CKAN",
     "type": "object"
 }

package/csv-dataset.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a underlyig spreadsheet row extracted from input spreadsheet.",
+    "title": "CSV Dataset Aspect",
+    "description": "Aspect capturing a underlyig spreadsheet row extracted from input spreadsheet.",
     "type": "object",
     "properties": {
         "json": {

package/csw-dataset.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a dataset according to a CSW server",
+    "title": "CSW Dataset Aspect",
+    "description": "Aspect capturing a complete representation of a dataset according to a CSW server",
     "type": "object",
     "properties": {
         "xml": {

package/csw-distribution.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a distribution according to a CSW server",
+    "title": "CSW Distribution Aspect",
+    "description": "Aspect capturing a complete representation of a distribution according to a CSW server",
     "type": "object",
     "properties": {
         "xml": {

package/currency.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "Currency",
+    "title": "Currency Aspect",
     "description": "Describes how up-to-date the dataset is",
     "type": "object",
     "properties": {

package/dap-dataset.schema.json

@@ -1,5 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a dataset according to DAP",
+    "title": "DAP Dataset Aspect",
+    "description": "Aspect capturing a complete representation of a dataset according to DAP",
     "type": "object"
 }

package/dap-resource.schema.json

@@ -1,5 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a resource according to DAP",
+    "title": "DAP Resource Aspect",
+    "description": "Aspect capturing a complete representation of a resource according to DAP",
     "type": "object"
 }

package/dataset-distributions.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "The distributions of a dataset",
+    "title": "Dataset Distributions Aspect",
     "description": "Specifies the list of distributions of a dataset.",
     "type": "object",
     "properties": {

package/dataset-format.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect containing the format of a distribution, and the probability that it's correct",
+    "title": "Dataset Format Aspect",
+    "description": "Aspect containing the format of a distribution, and the probability that it's correct",
     "type": "object",
     "properties": {
         "format": {

package/dataset-linked-data-rating.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect describing the linked data quality of the dataset out of 5 stars as per https://www.w3.org/DesignIssues/LinkedData.html",
+    "title": "Dataset Linked Data Rating Aspect",
+    "description": "Aspect describing the linked data quality of the dataset out of 5 stars as per https://www.w3.org/DesignIssues/LinkedData.html",
     "type": "object",
     "properties": {
         "stars": {

package/dataset-publisher.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "Dataset publisher",
+    "title": "Dataset Publisher Aspect",
     "description": "Links to the publisher of a dataset.",
     "type": "object",
     "properties": {

package/dataset-quality-rating.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect describing the quality rating of a dataset as determined by a number of different minions out of 100, along with the weight that they carry.",
+    "title": "Dataset Quality Aspect",
+    "description": "Aspect describing the quality rating of a dataset as determined by a number of different minions out of 100, along with the weight that they carry.",
     "type": "object",
     "properties": {
         "additionalProperties": {

package/dcat-dataset-strings.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "DCAT Dataset properties as strings",
+    "title": "Dataset DCAT Properties Aspect",
     "description": "The [DCAT Dataset](https://www.w3.org/TR/vocab-dcat/#class-dataset) properties represented as strings.  This aspect is intended to be quite permissive of arbitrary property values, even those that may be difficult or impossible to interpret.",
     "type": "object",
     "properties": {

package/dcat-distribution-strings.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "DCAT Distribution properties as strings",
+    "title": "Distribution DCAT Properties Aspect",
     "description": "The [DCAT Distribution](https://www.w3.org/TR/vocab-dcat/#class-distribution) properties represented as strings.  This aspect is intended to be quite permissive of arbitrary property values, even those that may be difficult or impossible to interpret.",
     "type": "object",
     "properties": {

package/information-security.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Metadata about information security",
+    "title": "Information Security Aspect",
+    "description": "Metadata about information security",
     "type": "object",
     "properties": {
         "classification": {

package/organization-details.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect for capturing basic details of an organization",
+    "title": "Organization Details Aspect",
+    "description": "Aspect for capturing basic details of an organization",
     "type": "object",
     "properties": {
         "name": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magda/registry-aspects",
-  "version": "1.2.1-alpha.0",
+  "version": "2.0.0-alpha.0",
   "description": "Common aspects for use with the registry.",
   "scripts": {
     "build": "echo \"ok\"",

package/project-open-data-dataset.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a dataset according to Project Open Data (data.json).",
+    "title": "Project Open Data Dataset Aspect",
+    "description": "Aspect capturing a complete representation of a dataset according to Project Open Data (data.json).",
     "type": "object",
     "allOf": [
         {

package/project-open-data-distribution.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect capturing a complete representation of a distribution according to Project Open Data (data.json).",
+    "title": "Project Open Data Distribution Aspect",
+    "description": "Aspect capturing a complete representation of a distribution according to Project Open Data (data.json).",
     "type": "object",
     "allOf": [
         {

package/project.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "Aspect for capturing the basic details of a project",
+    "title": "Project Information Aspect",
+    "description": "Aspect for capturing the basic details of a project",
     "type": "object",
     "properties": {
         "description": {

package/provenance.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/hyper-schema#",
-    "title": "Provenance",
+    "title": "Provenance Aspect",
     "description": "Describes how this data was collected or generated.",
     "type": "object",
     "properties": {

package/publishing.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "https://json-schema.org/draft/2019-09/hyper-schema#",
-    "title": "The publishing state of a dataset",
+    "title": "Dataset Publishing State Aspect",
     "description": "Specifies the state and other metadata associated with publication of data within MAGDA system.",
     "type": "object",
     "properties": {

package/source-link-status.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect describing source link status of a distribution (active or broken)",
+    "title": "Source Link Status Aspect",
+    "description": "Aspect describing source link status of a distribution (active or broken)",
     "type": "object",
     "properties": {
         "status": {

package/source.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect for capturing the source of a record",
+    "title": "Source Aspect",
+    "description": "Aspect for capturing the source of a record",
     "type": "object",
     "properties": {
         "id": {

package/spatial-coverage.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Spatial extent defined (will try to confom as much to) in geojson.",
+    "title": "Spatial Coverage Aspect",
+    "description": "Spatial extent defined (will try to confom as much to) in geojson.",
     "type": "object",
     "properties": {
         "bbox": {

package/temporal-coverage.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "The temporal period that the dataset covers",
+    "title": "Dataset Temporal Period Aspect",
     "description": "Specifies the temporal period that the dataset covers as a list of time intervals.",
     "type": "object",
     "properties": {

package/version.schema.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "dataset / distribution version",
+    "title": "Record Version Aspect",
     "description": "Provides version information of a dataset or distribution record. Verison should be bumped up when key event (e.g. current distribution is replaced by an new one or other key milestone) happens.",
     "type": "object",
     "properties": {

package/visualization-info.schema.json

@@ -1,6 +1,7 @@
 {
     "$schema": "http://json-schema.org/schema#",
-    "title": "Aspect providing information to make front-end visualisations of distributions better",
+    "title": "Visualiztion Information Aspect",
+    "description": "Aspect providing information to make front-end visualisations of distributions better",
     "type": "object",
     "properties": {
         "format": {