Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

record-package-schema: deprecate packages #1339

Merged
merged 6 commits into from
Jul 19, 2021
Merged

record-package-schema: deprecate packages #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a569352
record-package-schema: deprecated packages
yolile Jul 15, 2021
a99b3db
changelog: Add deprecate record package packages field
yolile Jul 15, 2021
f2c3756
record-package-schema: clarify packages deprecation description
yolile Jul 16, 2021
c562b56
Merge branch '1.2-dev' of github.com:open-contracting/standard into 9…
yolile Jul 16, 2021
423c177
examples: remove packages from record packages
yolile Jul 16, 2021
8e41cff
records_referece: remove record package 'packages' reference
yolile Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/examples/merging/example02-field-record.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 0 additions & 4 deletions docs/examples/merging/example02-object-record.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 0 additions & 4 deletions docs/examples/merging/example03-record.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 0 additions & 7 deletions docs/examples/merging/merged-tender.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 0 additions & 7 deletions docs/examples/merging/merged.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 0 additions & 7 deletions docs/examples/merging/versioned.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
9 changes: 0 additions & 9 deletions docs/examples/record-embedded-releases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
9 changes: 0 additions & 9 deletions docs/examples/record.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
6 changes: 0 additions & 6 deletions docs/examples/records/award.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 0 additions & 7 deletions docs/examples/records/contract.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
9 changes: 0 additions & 9 deletions docs/examples/records/contractAmendment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
8 changes: 0 additions & 8 deletions docs/examples/records/implementation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
3 changes: 0 additions & 3 deletions docs/examples/records/planning.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 0 additions & 4 deletions docs/examples/records/tender.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 0 additions & 5 deletions docs/examples/records/tenderUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions docs/history/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 3 additions & 6 deletions docs/schema/records_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
6 changes: 5 additions & 1 deletion schema/record-package-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down