From b7d0bfdc19ec77f5cafcf5a3a01a87abe31dbdba Mon Sep 17 00:00:00 2001 From: roll Date: Sat, 27 Apr 2024 14:20:13 +0100 Subject: [PATCH 1/7] Clarify `resource.path` for Tabular Data Resource --- content/docs/specifications/data-resource.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/docs/specifications/data-resource.md b/content/docs/specifications/data-resource.md index d5bf3d4b..978bb1e5 100644 --- a/content/docs/specifications/data-resource.md +++ b/content/docs/specifications/data-resource.md @@ -200,7 +200,9 @@ List of licenses as for [Data Package](../data-package/#licenses). If not specif The properties below are applicable to any Tabular Data Resource. -#### `data` +#### `path` or `data` [required] + +If the `path` property is used for providing data than it `MUST` contain [Tabular Data](../glossary/#tabular-data). If the `data` property is used for providing data for a Tabular Data Resource than it `MUST` be an `array` where each item in the array `MUST` be either: From 13149bcaa6e797ec068c16f7ffd0298b0dbb0d8f Mon Sep 17 00:00:00 2001 From: roll Date: Sat, 27 Apr 2024 15:00:50 +0100 Subject: [PATCH 2/7] Fixed `$schema` definition --- content/docs/specifications/data-package.md | 2 +- content/docs/specifications/data-resource.md | 2 +- content/docs/specifications/table-dialect.md | 2 +- content/docs/specifications/table-schema.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 6118f45d..65959500 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -116,7 +116,7 @@ Packaged data resources are described in the `resources` property of the package ### `$schema` -A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/datapackage.json` and the recommended value is `https://datapackage.org/profiles/2.0/datapackage.json`. diff --git a/content/docs/specifications/data-resource.md b/content/docs/specifications/data-resource.md index 978bb1e5..2be7bc64 100644 --- a/content/docs/specifications/data-resource.md +++ b/content/docs/specifications/data-resource.md @@ -146,7 +146,7 @@ If a resource has `profile` property that equals to `tabular-data-resource` or ` #### `$schema` -A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/dataresource.json` and the recommended value is `https://datapackage.org/profiles/2.0/dataresource.json`. diff --git a/content/docs/specifications/table-dialect.md b/content/docs/specifications/table-dialect.md index f80375f3..20250ae7 100644 --- a/content/docs/specifications/table-dialect.md +++ b/content/docs/specifications/table-dialect.md @@ -72,7 +72,7 @@ General properties are format-agnostic. Usually, there are useful for defining d #### `$schema` -A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/tabledialect.json` and the recommended value is `https://datapackage.org/profiles/2.0/tabledialect.json`. diff --git a/content/docs/specifications/table-schema.md b/content/docs/specifications/table-schema.md index 69aef6ef..5cdec350 100644 --- a/content/docs/specifications/table-schema.md +++ b/content/docs/specifications/table-schema.md @@ -109,7 +109,7 @@ The way Table Schema `fields` are mapped onto the data source fields are defined #### `$schema` -A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/tableschema.json` and the recommended value is `https://datapackage.org/profiles/2.0/tableschema.json`. From c2c061f952031402b85ac4f1b5dee18549c015ef Mon Sep 17 00:00:00 2001 From: roll Date: Sat, 27 Apr 2024 15:08:13 +0100 Subject: [PATCH 3/7] Make Data Package descriptor requirements compatible to data APIs --- content/docs/specifications/data-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 65959500..c6df91a5 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -77,7 +77,7 @@ Several example data packages can be found in the [datasets organization on gith Data Package descriptor `MUST` be a descriptor as per [Descriptor](../glossary/#descriptor) definition. A list of standard properties that can be included into a descriptor is defined in the [Properties](#properties) section. -When available as a file a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed in the top-level directory (relative to any other resources provided as part of the data package). +When a data package is available as a physical or virtual directory containing files, a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed on the top-level of the file structure (relative to any other resources provided as part of the data package). The descriptor is the central file in a Data Package. It provides: From 395f1460c68bacc18cf52837c4ae07dbd566288e Mon Sep 17 00:00:00 2001 From: roll Date: Sat, 27 Apr 2024 15:22:14 +0100 Subject: [PATCH 4/7] Added related work to data package (fixes https://github.com/frictionlessdata/specs/issues/65) --- content/docs/specifications/data-package.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index c6df91a5..d95e8b00 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -266,3 +266,15 @@ An example of the object structure is as follows: "path": "http://data.worldbank.org/indicator/NY.GDP.MKTP.CD" }] ``` + +## Related Work + +Data Package draws content and/or inspiration from, among others, the following specifications and implementations: + +- [DataCite](https://schema.datacite.org/) +- [Zenodo](https://zenodo.org/) +- [DCAT](https://www.w3.org/TR/vocab-dcat-3/) +- [CKAN](https://ckan.org/) +- [OAI-ORE](https://www.openarchives.org/ore/) +- [DataONE](https://dataone-architecture-documentation.readthedocs.io/en/latest/design/DataPackage.html) +- [Research Object Bundle](https://www.researchobject.org/specifications/bundle/) From a023403d26a23fb3dc359a8e4a6e637c36b895ff Mon Sep 17 00:00:00 2001 From: roll Date: Mon, 6 May 2024 15:08:32 +0100 Subject: [PATCH 5/7] Make `resource.sources` inherits from `package.sources` (#57) --- content/docs/specifications/data-resource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/specifications/data-resource.md b/content/docs/specifications/data-resource.md index 2be7bc64..87086287 100644 --- a/content/docs/specifications/data-resource.md +++ b/content/docs/specifications/data-resource.md @@ -190,7 +190,7 @@ The MD5 hash for this resource. Other algorithms can be indicated by prefixing t #### `sources` -List of data sources as for [Data Package](../data-package/#sources). +List of data sources as for [Data Package](../data-package/#sources). If not specified the resource inherits from the data package. #### `licenses` From f7aab48e8c9f3050737324c9c54bf5ac8424ab14 Mon Sep 17 00:00:00 2001 From: roll Date: Mon, 6 May 2024 15:22:53 +0100 Subject: [PATCH 6/7] Hide recipes that are expected to make Data Package (v2) specs --- content/docs/recipes/enum-labels-and-ordering.md | 2 ++ content/docs/recipes/metadata-in-table-schema.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/content/docs/recipes/enum-labels-and-ordering.md b/content/docs/recipes/enum-labels-and-ordering.md index b7ca8358..d0de5c3f 100644 --- a/content/docs/recipes/enum-labels-and-ordering.md +++ b/content/docs/recipes/enum-labels-and-ordering.md @@ -1,5 +1,7 @@ --- title: Enum Labels and Ordering +sidebar: + hidden: true --- diff --git a/content/docs/recipes/metadata-in-table-schema.md b/content/docs/recipes/metadata-in-table-schema.md index 25df3026..17e6b1fb 100644 --- a/content/docs/recipes/metadata-in-table-schema.md +++ b/content/docs/recipes/metadata-in-table-schema.md @@ -1,5 +1,7 @@ --- title: Metadata in Table Schema +sidebar: + hidden: true ---
From a390ca7baec5540e95b87b95f118acb0d5854fe4 Mon Sep 17 00:00:00 2001 From: roll Date: Mon, 6 May 2024 15:24:21 +0100 Subject: [PATCH 7/7] Fixed the recipes guide --- content/docs/standard/recipes.mdx | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/content/docs/standard/recipes.mdx b/content/docs/standard/recipes.mdx index 5a3915ca..98805977 100644 --- a/content/docs/standard/recipes.mdx +++ b/content/docs/standard/recipes.mdx @@ -90,18 +90,6 @@ Recipes are various approaches for solving common problems, in ways that are not href="/recipes/external-foreign-keys" /> - - - -