Merge pull request #1339 from open-contracting/920-deprecate-packages

record-package-schema: deprecate packages
open-contracting · Jul 19, 2021 · 90c6d4f · 90c6d4f
2 parents 34f6e77 + 8e41cff
commit 90c6d4f
Show file tree

Hide file tree

Showing 18 changed files with 9 additions and 100 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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",

diff --git a/docs/history/changelog.md b/docs/history/changelog.md
@@ -106,6 +106,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.

diff --git 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
 ```
 

diff --git 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 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"
+ }
  },
  "records": {
  "title": "Records",