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: remove releases in record requirement #1393

Merged
merged 4 commits into from
Sep 1, 2021
Merged

record-package-schema: remove releases in record requirement #1393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
188a54d
record-package-schema: remove releases in record requirement
yolile Aug 24, 2021
de3c6a4
changelog: add records.releases entry
yolile Aug 24, 2021
8afa65e
Apply suggestions from code review
yolile Aug 31, 2021
62fbc07
recods_reference: remove record.releases admonition
yolile Aug 31, 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
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 @@ -169,6 +169,7 @@ Per the [normative and non-normative content and changes policy](https://docs.go
* [#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`.
* [#1374](https://github.com/open-contracting/standard/pull/1374) Remove `records.minItems` requirement.
* [#1393](https://github.com/open-contracting/standard/pull/1393) Remove `releases` as a required field of the `Record` object.

* Release package schema:
* [#1374](https://github.com/open-contracting/standard/pull/1374) Remove `releases.minItems` requirement.
Expand Down
5 changes: 3 additions & 2 deletions docs/schema/records_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ The following example demonstrates the package metadata and record fields.

## Record structure

A record **must** contain an [ocid](identifiers.md#open-contracting-process-identifier-ocid) and all [releases](#releases) about the contracting process at the time of the record's publication. As such, a record functions as an index of releases about a contracting process.
A record **must** contain an [ocid](identifiers.md#open-contracting-process-identifier-ocid) and one or more of:

A record **should** contain a [compiledRelease](#compiled-release) object, which represents the state of the contracting process at the time of the record's publication.
* All [releases](#releases) about the contracting process at the time of the record's publication.
* A [compiledRelease](#compiled-release) object, which represents the state of the contracting process at the time of the record's publication.

A record **may** contain a [versionedRelease](#versioned-release) object, which aggregates, into a single object, all values of all fields from all releases up to the time of the record's publication. The versioned release is designed to make it easy to see how values change from one release to another, and will often be generated by data users, rather than by publishers.

Expand Down
3 changes: 1 addition & 2 deletions schema/record-package-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,7 @@
}
},
"required": [
"ocid",
"releases"
"ocid"
]
},
"LinkedRelease": {
Expand Down