From a569352210aae52c298e9faff79f1218bcb38be9 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Thu, 15 Jul 2021 14:33:33 -0400 Subject: [PATCH 1/5] record-package-schema: deprecated packages Signed-off-by: Yohanna Lisnichuk --- schema/record-package-schema.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/schema/record-package-schema.json b/schema/record-package-schema.json index ac9d71cb3..471f56fd7 100644 --- a/schema/record-package-schema.json +++ b/schema/record-package-schema.json @@ -99,7 +99,11 @@ "type": "string", "format": "uri" }, - "uniqueItems": true + "uniqueItems": true, + "deprecated": { + "description": "This field hadn't clear and real use cases.", + "deprecatedVersion": "1.2" + } }, "records": { "title": "Records", From a99b3db719be8c6544de4b2a5a29440a6c6761e5 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Thu, 15 Jul 2021 14:36:29 -0400 Subject: [PATCH 2/5] changelog: Add deprecate record package packages field Signed-off-by: Yohanna Lisnichuk --- docs/history/changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/history/changelog.md b/docs/history/changelog.md index 5fc735c61..8ffe8059a 100644 --- a/docs/history/changelog.md +++ b/docs/history/changelog.md @@ -105,6 +105,7 @@ Per the [normative and non-normative content and changes policy](https://docs.go * [#1241](https://github.com/open-contracting/standard/pull/1241) In the definition section, rename record to `Record` and add `LinkedRelease`. * [#1241](https://github.com/open-contracting/standard/pull/1241) Align descriptions of `Record` `releases`, linked releases and embedded releases. * [#1307](https://github.com/open-contracting/standard/pull/1307) Clarify uniqueness rules for records. + * [#1339](https://github.com/open-contracting/standard/pull/1339) Deprecate `packages` * Improve the clarity of field descriptions in the release package schema and record package schema: * [#1067](https://github.com/open-contracting/standard/pull/1067) `Publisher.name`, to indicate that it is the organization or department responsible for publishing the OCDS version of the data. * [#1257](https://github.com/open-contracting/standard/pull/1257) Remove default value of `"en"` for `language` field. From f2c3756517fa4dd21d74a563aab8a23451552ab8 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Fri, 16 Jul 2021 16:02:17 -0400 Subject: [PATCH 3/5] record-package-schema: clarify packages deprecation description Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> --- docs/history/changelog.md | 2 +- schema/record-package-schema.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/history/changelog.md b/docs/history/changelog.md index 8ffe8059a..77fd16033 100644 --- a/docs/history/changelog.md +++ b/docs/history/changelog.md @@ -105,7 +105,7 @@ Per the [normative and non-normative content and changes policy](https://docs.go * [#1241](https://github.com/open-contracting/standard/pull/1241) In the definition section, rename record to `Record` and add `LinkedRelease`. * [#1241](https://github.com/open-contracting/standard/pull/1241) Align descriptions of `Record` `releases`, linked releases and embedded releases. * [#1307](https://github.com/open-contracting/standard/pull/1307) Clarify uniqueness rules for records. - * [#1339](https://github.com/open-contracting/standard/pull/1339) Deprecate `packages` + * [#1339](https://github.com/open-contracting/standard/pull/1339) Deprecate `packages`. * Improve the clarity of field descriptions in the release package schema and record package schema: * [#1067](https://github.com/open-contracting/standard/pull/1067) `Publisher.name`, to indicate that it is the organization or department responsible for publishing the OCDS version of the data. * [#1257](https://github.com/open-contracting/standard/pull/1257) Remove default value of `"en"` for `language` field. diff --git a/schema/record-package-schema.json b/schema/record-package-schema.json index 471f56fd7..d9eac55ff 100644 --- a/schema/record-package-schema.json +++ b/schema/record-package-schema.json @@ -101,7 +101,7 @@ }, "uniqueItems": true, "deprecated": { - "description": "This field hadn't clear and real use cases.", + "description": "This field is deprecated, because it is rarely implemented, is rarely used, and depends on a publication pattern in which release packages are published at stable URLs.", "deprecatedVersion": "1.2" } }, From 423c1775c9c23879c1448c4b66ed5477d3e43bd6 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Fri, 16 Jul 2021 17:13:19 -0400 Subject: [PATCH 4/5] examples: remove packages from record packages Signed-off-by: Yohanna Lisnichuk --- docs/examples/merging/example02-field-record.json | 4 ---- docs/examples/merging/example02-object-record.json | 4 ---- docs/examples/merging/example03-record.json | 4 ---- docs/examples/merging/merged-tender.json | 7 ------- docs/examples/merging/merged.json | 7 ------- docs/examples/merging/versioned.json | 7 ------- docs/examples/record-embedded-releases.json | 9 --------- docs/examples/record.json | 9 --------- docs/examples/records/award.json | 6 ------ docs/examples/records/contract.json | 7 ------- docs/examples/records/contractAmendment.json | 9 --------- docs/examples/records/implementation.json | 8 -------- docs/examples/records/planning.json | 3 --- docs/examples/records/tender.json | 4 ---- docs/examples/records/tenderUpdate.json | 5 ----- 15 files changed, 93 deletions(-) diff --git a/docs/examples/merging/example02-field-record.json b/docs/examples/merging/example02-field-record.json index ea7f0d602..2647c4761 100644 --- a/docs/examples/merging/example02-field-record.json +++ b/docs/examples/merging/example02-field-record.json @@ -5,10 +5,6 @@ }, "publishedDate": "", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-k50g02-13-9-368828-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-k50g02-13-9-368828-tender.json" - ], "records": [ { "ocid": "ocds-k50g02-13-9-368828", diff --git a/docs/examples/merging/example02-object-record.json b/docs/examples/merging/example02-object-record.json index 251fba5e1..10c95e658 100644 --- a/docs/examples/merging/example02-object-record.json +++ b/docs/examples/merging/example02-object-record.json @@ -5,10 +5,6 @@ }, "publishedDate": "", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-k50g02-11-13-651832-tenderUpdate.json", - "https://standard.open-contracting.org/examples/releases/ocds-k50g02-11-13-651832-tender.json" - ], "records": [ { "ocid": "ocds-k50g02-11-13-651832", diff --git a/docs/examples/merging/example03-record.json b/docs/examples/merging/example03-record.json index 8a8cda735..fbafb3162 100644 --- a/docs/examples/merging/example03-record.json +++ b/docs/examples/merging/example03-record.json @@ -5,10 +5,6 @@ }, "publishedDate": "", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-23g63a01-200502-awardAmendment.json", - "https://standard.open-contracting.org/examples/releases/ocds-23g63a01-200502-award.json" - ], "records": [ { "ocid": "ocds-23g63a01-200502", diff --git a/docs/examples/merging/merged-tender.json b/docs/examples/merging/merged-tender.json index c607b3d80..b61e243d8 100644 --- a/docs/examples/merging/merged-tender.json +++ b/docs/examples/merging/merged-tender.json @@ -10,13 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award1.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award2.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-update.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-amendment.json" - ], "records": [ { "ocid": "ocds-213czf-000-00002", diff --git a/docs/examples/merging/merged.json b/docs/examples/merging/merged.json index c607b3d80..b61e243d8 100644 --- a/docs/examples/merging/merged.json +++ b/docs/examples/merging/merged.json @@ -10,13 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award1.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award2.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-update.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-amendment.json" - ], "records": [ { "ocid": "ocds-213czf-000-00002", diff --git a/docs/examples/merging/versioned.json b/docs/examples/merging/versioned.json index 4c50dbb94..11e9f0512 100644 --- a/docs/examples/merging/versioned.json +++ b/docs/examples/merging/versioned.json @@ -10,13 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award1.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-award2.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-update.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00002-01-tender-amendment.json" - ], "records": [ { "ocid": "ocds-213czf-000-00002", diff --git a/docs/examples/record-embedded-releases.json b/docs/examples/record-embedded-releases.json index 68fd65ec6..18338f241 100644 --- a/docs/examples/record-embedded-releases.json +++ b/docs/examples/record-embedded-releases.json @@ -1,14 +1,5 @@ { "extensions": [], - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json#ocds-213czf-000-00001-01-planning", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json#ocds-213czf-000-00001-02-tender", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderAmendment.json#ocds-213czf-000-00001-03-tenderAmendment", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderAmendment.json#ocds-213czf-000-00001-03-tenderUpdate", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json#ocds-213czf-000-00001-04-award", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json#ocds-213czf-000-00001-05-contract", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json#ocds-213czf-000-00001-06-implementation" - ], "publishedDate": "2014-02-02T13:02:00Z", "publisher": { "name": "Open Data Services Co-operative Limited", diff --git a/docs/examples/record.json b/docs/examples/record.json index 036f9ef3f..d094c426e 100644 --- a/docs/examples/record.json +++ b/docs/examples/record.json @@ -1,14 +1,5 @@ { "extensions": [], - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json#ocds-213czf-000-00001-01-planning", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json#ocds-213czf-000-00001-02-tender", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderAmendment.json#ocds-213czf-000-00001-03-tenderAmendment", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderAmendment.json#ocds-213czf-000-00001-03-tenderUpdate", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json#ocds-213czf-000-00001-04-award", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json#ocds-213czf-000-00001-05-contract", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json#ocds-213czf-000-00001-06-implementation" - ], "publishedDate": "2014-02-02T13:02:00Z", "publisher": { "name": "Open Data Services Co-operative Limited", diff --git a/docs/examples/records/award.json b/docs/examples/records/award.json index cc8972747..84b96df95 100644 --- a/docs/examples/records/award.json +++ b/docs/examples/records/award.json @@ -10,12 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/contract.json b/docs/examples/records/contract.json index 16dbb8ac2..2a17c9aec 100644 --- a/docs/examples/records/contract.json +++ b/docs/examples/records/contract.json @@ -10,13 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/contractAmendment.json b/docs/examples/records/contractAmendment.json index d9f31d854..45d76783d 100644 --- a/docs/examples/records/contractAmendment.json +++ b/docs/examples/records/contractAmendment.json @@ -10,15 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-06-implementation.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-07-contractAmendment.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/implementation.json b/docs/examples/records/implementation.json index a1247a337..d02df8584 100644 --- a/docs/examples/records/implementation.json +++ b/docs/examples/records/implementation.json @@ -10,14 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-06-implementation.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/planning.json b/docs/examples/records/planning.json index 9f69495cc..f3cda581e 100644 --- a/docs/examples/records/planning.json +++ b/docs/examples/records/planning.json @@ -10,9 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/tender.json b/docs/examples/records/tender.json index 9d72deb4b..bdf7288ea 100644 --- a/docs/examples/records/tender.json +++ b/docs/examples/records/tender.json @@ -10,10 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", diff --git a/docs/examples/records/tenderUpdate.json b/docs/examples/records/tenderUpdate.json index d17b9f9e3..418538cf1 100644 --- a/docs/examples/records/tenderUpdate.json +++ b/docs/examples/records/tenderUpdate.json @@ -10,11 +10,6 @@ "license": "http://opendatacommons.org/licenses/pddl/1.0/", "publicationPolicy": "https://github.com/open-contracting/sample-data/", "version": "1.1", - "packages": [ - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-01-planning.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json", - "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json" - ], "records": [ { "ocid": "ocds-213czf-000-00001", From 8e41cffbc23e7195fc9cd4d8c2c155ca75622f12 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Fri, 16 Jul 2021 17:13:46 -0400 Subject: [PATCH 5/5] records_referece: remove record package 'packages' reference Signed-off-by: Yohanna Lisnichuk --- docs/schema/records_reference.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/schema/records_reference.md b/docs/schema/records_reference.md index 8a638c945..fda5fe420 100644 --- a/docs/schema/records_reference.md +++ b/docs/schema/records_reference.md @@ -22,16 +22,13 @@ See the [licensing guidance](../guidance/publish.md#license-your-data) for more See the [publication policy](../guidance/publish.md#finalize-your-publication-policy) guidance for more details on what to include in a publication policy. -The record package metadata has two differences from the release package metadata: +The record package metadata has one difference from the release package metadata: instead of a `releases` array, a record package has a `records` array containing one or more records. -* Instead of a `releases` array, a record package has a `records` array containing one or more records. -* A record package has a `packages` array, to link to any release packages that were used to prepare the records. - -The following example demonstrates all package metadata and record fields. +The following example demonstrates the package metadata and record fields. ```{jsoninclude} ../examples/merging/versioned.json :jsonpointer: -:expand: packages, records +:expand: records :title: package ```