Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit 899204f

Browse files
committed
Update metadata changelog
1 parent a6266f3 commit 899204f

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

Diff for: metadata-changelog.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,44 @@ This page lists changes to the common core metadata schema by version. Latest ch
1111

1212
### Version 1.1 _(DRAFT - as of 10/6/2014)_
1313

14-
##### NEW Catalog Required Fields
15-
* Adds `conformsTo` field, required at the catalog level to specify the schema and optional at the `dataset` and `distribution` level ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309), [#362](https://github.com/project-open-data/project-open-data.github.io/issues/362))
16-
* Adds `dataset` field, required at the catalog level to wrap all datasets listed within an overarching "catalog" object that wraps the entire data.json file ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309))
14+
##### Catalog Required Fields
15+
* Adds required `conformsTo` field to specify the schema version ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309))
16+
* Adds required `dataset` field as a container for all datasets listed ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309))
17+
* Adds optional `describedBy` field to specify a canonical or customized JSON schema file ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
1718

18-
##### “Common Core” Required Fields
19+
##### Dataset Required Fields
1920
* Changes `contactPoint` field to an object that contains the name (`fn`) and email address (`hasEmail`) ([#358](https://github.com/project-open-data/project-open-data.github.io/issues/358))
2021
* Adds `fn` field as part of `contactPoint` replacing earlier use of `contactPoint` ([#358](https://github.com/project-open-data/project-open-data.github.io/issues/358))
2122
* Renames `mbox` field to `hasEmail` and moves to within `contactPoint` ([#358](https://github.com/project-open-data/project-open-data.github.io/issues/358))
2223
* Changes `publisher` field to an object that allows multiple levels of organizations ([#296](https://github.com/project-open-data/project-open-data.github.io/issues/296))
24+
* Adds `name` as part of `publisher` replacing earlier use of `publisher` ([#296](https://github.com/project-open-data/project-open-data.github.io/issues/296))
25+
* Adds optional `subOrganizationOf` field as part of `publisher` to include parent organization hierarchy ([#296](https://github.com/project-open-data/project-open-data.github.io/issues/296))
2326

24-
##### “Common Core” Required-if-Applicable Fields
27+
##### Dataset Required-if-Applicable Fields
28+
* Removes `webService` field. APIs can be described within a `distribution` using `accessURL` and `format` ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291))
2529
* Renames `accessLevelComment` field to `rights` ([#353](https://github.com/project-open-data/project-open-data.github.io/issues/353))
26-
* Changes `distribution` field to become required-if-applicable and to always contain the `accessURL` or `downloadURL` fields ([#217](https://github.com/project-open-data/project-open-data.github.io/issues/217))
2730
* Changes `license` field to be a URL ([196](https://github.com/project-open-data/project-open-data.github.io/issues/196))
28-
* Removes `webService` field. APIs can be described within a `distribution` using `accessURL` and `format` ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291))
31+
* Changes `distribution` field to become required-if-applicable and to always contain the `accessURL` or `downloadURL` fields ([#217](https://github.com/project-open-data/project-open-data.github.io/issues/217))
2932

30-
##### NEW “Common Core” Distribution Fields
33+
##### Dataset Distribution Fields
3134
* Adds required-if-applicable `downloadURL` field to replace earlier use of `accessURL` and to exist as a field within `distribution` ([#335](https://github.com/project-open-data/project-open-data.github.io/issues/335))
3235
* Adds required-if-applicable `mediaType` field to replace earlier use of `format` and to exist as a field within `distribution` ([#272](https://github.com/project-open-data/project-open-data.github.io/issues/272))
3336
* Changes `accessURL` field to represent indirect access and to exist only as an optional field within `distribution` ([#217](https://github.com/project-open-data/project-open-data.github.io/issues/217), [#335](https://github.com/project-open-data/project-open-data.github.io/issues/335))
3437
* Changes `format` field to a human readable description and to exist only as an optional field within `distribution` ([#272](https://github.com/project-open-data/project-open-data.github.io/issues/272), [#293](https://github.com/project-open-data/project-open-data.github.io/issues/293))
3538
* Adds optional `description` field for use within `distribution` ([#248](https://github.com/project-open-data/project-open-data.github.io/issues/248))
3639
* Adds optional `title` field for use within `distribution` ([#248](https://github.com/project-open-data/project-open-data.github.io/issues/248))
37-
* Note: the newly added `conformsTo`, `describeBy`, and `describeByType` can be used as optional fields at the `distribution` level as well.
40+
* Adds optional `describedBy` field to specify a distribution specific data dictionary ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
41+
* Adds optional `describedByType` field to specify the format of the data dictionary referenced with `describedBy` ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
42+
* Adds optional `conformsTo` field to specify a standard the distribution conforms to ([#362](https://github.com/project-open-data/project-open-data.github.io/issues/362))
3843

3944
##### Expanded Fields
4045
* Changes `accrualPeriodicity` field to use ISO 8601 date syntax ([#292](https://github.com/project-open-data/project-open-data.github.io/issues/292))
41-
* Renames `dataDictionary` field to `describedBy`. This optional field can be used at the catalog, `dataset`, and `distribution` level ([#309](https://github.com/project-open-data/project-open-data.github.io/issues/309), [#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
42-
* Adds optional `describedByType` field at the `dataset` and `distribution` level ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
43-
* Adds optional `isPartOf` field to group datasets as a collection ([#258](https://github.com/project-open-data/project-open-data.github.io/issues/258))
4446
* Renames `PrimaryITInvestmentUII` field to `primaryITInvestmentUII` to use capitalization consistent with the rest of the schema ([#284](https://github.com/project-open-data/project-open-data.github.io/issues/284))
47+
* Renames `dataDictionary` field to `describedBy` ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
48+
* Adds optional `describedByType` field ([#291](https://github.com/project-open-data/project-open-data.github.io/issues/291), [#332](https://github.com/project-open-data/project-open-data.github.io/issues/332))
49+
* Adds optional `conformsTo` field to specify a standard the dataset conforms to ([#362](https://github.com/project-open-data/project-open-data.github.io/issues/362))
50+
* Adds optional `isPartOf` field to group datasets as a collection ([#258](https://github.com/project-open-data/project-open-data.github.io/issues/258))
51+
4552

4653
### Version 1.0 FINAL - 9/20/2013
4754

0 commit comments

Comments
 (0)