Skip to content

Commit

Permalink
docs/schema/records_reference.md: Add jsonschema directive for Record
Browse files Browse the repository at this point in the history
  • Loading branch information
duncandewhurst committed Oct 2, 2023
1 parent aaedd93 commit 2f239e4
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/schema/records_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following example demonstrates the package metadata and record fields.
:title: package
```

## Record structure
## Record

A record **must** contain an [ocid](identifiers.md#open-contracting-process-identifier-ocid) and one or more of:

Expand All @@ -47,6 +47,11 @@ A record **must** contain an [ocid](identifiers.md#open-contracting-process-iden

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.

```{jsonschema} ../../build/current_lang/record-package-schema.json
:pointer: /definitions/Record
:nocrossref:
```

### Releases

Each release in a record can be provided as either a linked release or an embedded release.
Expand Down

0 comments on commit 2f239e4

Please sign in to comment.