Skip to content

Commit

Permalink
Merge pull request #1393 from open-contracting/1092-releases-optional…
Browse files Browse the repository at this point in the history
…-record

record-package-schema: remove releases in record requirement
  • Loading branch information
jpmckinney authored Sep 1, 2021
2 parents 091e41e + 62fbc07 commit 46be658
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/history/changelog.md
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,7 @@
}
},
"required": [
"ocid",
"releases"
"ocid"
]
},
"LinkedRelease": {
Expand Down

0 comments on commit 46be658

Please sign in to comment.