diff --git a/readme.md b/readme.md index 00b42d4..fb2c898 100644 --- a/readme.md +++ b/readme.md @@ -1,15 +1,15 @@ -The Data Marketplace -==================== +Data Catalogue Metadata +======================= -This repository stores objects (JSON Schema) that are used to define the structure of objects passed to and from the Data -Marketplace and the API specification for the interface through which the objects will be transported. +This repository stores objects (JSON Schema) that are used to define the structure of objects passed to and from Data Catalogues +such as the Data Marketplace and the API specification for the interface through which the objects will be transported. JSON Schema ----------- A JSON Schema provides a computer readable description of a metadata data object. The project’s schema can be compared to a JSON -representation of a Data Marketplace resource’s metadata with the output being a report describing the discrepancies between the +representation of a Data Catalogue's resource’s metadata with the output being a report describing the discrepancies between the two. This allows the schema to be used to validate metadata records. Due to the straightforward structure of JSON the description can also be read by people such that it is also a useful tool to aid diff --git a/schema/catalogued_resource_schema.json b/schema/catalogued_resource_schema.json index e66f2e5..e3dab83 100644 --- a/schema/catalogued_resource_schema.json +++ b/schema/catalogued_resource_schema.json @@ -62,7 +62,7 @@ }, "modified": { "description": "The date on which the data was created or last updated.", - "$ref": "./../schema/shared_schema.json#/schemas/dateOrDateTime" + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/shared_schema.json#/schemas/dateOrDateTime" }, "publisher": { "description": "The entity responsible for making the catalogued resource publicly available.", diff --git a/schema/data_group_schema.json b/schema/data_group_schema.json index 3df5313..fd3fb3d 100644 --- a/schema/data_group_schema.json +++ b/schema/data_group_schema.json @@ -4,7 +4,7 @@ "$id": "schemas/dataGroup", "description": "Metadata schema for a Data group", "type": "object", - "$ref": "./../schema/catalogued_resource_schema.json", + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/catalogued_resource_schema.json", "properties": { "endpointDescription": { "description": "A description of the services available via the end-points, including their operations, parameters etc.", diff --git a/schema/data_service_schema.json b/schema/data_service_schema.json index 2698c50..de2283f 100644 --- a/schema/data_service_schema.json +++ b/schema/data_service_schema.json @@ -4,7 +4,7 @@ "$id": "schemas/dataService", "description": "Metadata schema for a Data Service", "type": "object", - "$ref": "./../schema/catalogued_resource_schema.json", + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/catalogued_resource_schema.json", "properties": { "apiType": { "description": "The API type.", diff --git a/schema/data_share_schema.json b/schema/data_share_schema.json index 5f65274..53febf6 100644 --- a/schema/data_share_schema.json +++ b/schema/data_share_schema.json @@ -4,7 +4,7 @@ "$id": "schemas/dataShare", "description": "Metadata schema for a Data Share", "type": "object", - "$ref": "./../schema/catalogued_resource_schema.json", + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/catalogued_resource_schema.json", "properties": { "relatedResource": { "description": "The identifier of a catalogued resource that is the target of this share request", diff --git a/schema/dataset_schema.json b/schema/dataset_schema.json index a540e46..b6eba70 100644 --- a/schema/dataset_schema.json +++ b/schema/dataset_schema.json @@ -4,7 +4,7 @@ "$id": "schemas/dataset", "description": "Metadata schema for a Dataset", "type": "object", - "$ref": "./../schema/catalogued_resource_schema.json", + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/catalogued_resource_schema.json", "properties": { "distribution": { "description": "A collection of distributions", @@ -39,7 +39,7 @@ }, "issued": { "description": "The date the data was issued.", - "$ref": "./../schema/shared_schema.json#/schemas/dateOrDateTime" + "$ref": "https://co-cddo.github.io/data-catalogue-metadata/schema/shared_schema.json#/schemas/dateOrDateTime" }, "updateFrequency": { "description": "The schedule for how often the data is updated",