Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/schema/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ The Open Contracting Data Standard is maintained using JSON Schema.

In this section you will find the schemas for [releases](release) and [records](record) along with the schemas for [packaging](packaging/index.md), which act as envelopes for releases and records.

```{admonition} Working on a new implementation or looking to improve data quality?
:class: attention

To improve the quality of your data and to increase compatibility with future versions of OCDS, you are encouraged to use the 'strict' versions of the schemas.

The strict schemas add additional validation rules planned for inclusion in OCDS 2.0. Use of the strict schemas is a voluntary opportunity to improve data quality.

To browse the strict schemas, use the interactive browsers for the [release schema](release), the [record schema](record), the [release package schema](packaging/release_package) and the [record package schema](packaging/record_package).
```

The [release schema reference](reference) provides guidance on using each of the [sections](reference.md#release-structure) and [building blocks](reference.md#building-block-reference) in the schema, and the [record schema reference](records_reference) provides additional information on publishing records with compiled and versioned releases.

OCDS data must follow the I-JSON (Internet JSON) specification in [RFC7493](https://tools.ietf.org/html/rfc7493), according to which JSON text must be encoded using [UTF-8](https://en.wikipedia.org/wiki/UTF-8), and which introduces a number of requirements for numbers, objects and dates.
Expand Down
12 changes: 11 additions & 1 deletion docs/schema/packaging/record_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,17 @@ This page presents the record package schema in an interactive browser and in a

Click on schema elements to expand the tree, or use the '+' icon to expand all elements. Use { } to view the underlying schema for any section. Required fields are indicated in **bold**. [Deprecated fields](../../governance/deprecation) are omitted.

<script src="../../../_static/docson/public/js/widget.js" data-schema="../../../record-package-schema.json"></script>
````{tab-set}

```{tab-item} Record package schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../record-package-schema.json"></script>
```

```{tab-item} Strict record package schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../strict/record-package-schema.json"></script>
```

````

## Reference table

Expand Down
12 changes: 11 additions & 1 deletion docs/schema/packaging/release_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,17 @@ This page presents the release package schema in an interactive browser and in a

Click on schema elements to expand the tree, or use the '+' icon to expand all elements. Use { } to view the underlying schema for any section. Required fields are indicated in **bold**. [Deprecated fields](../../governance/deprecation) are omitted.

<script src="../../../_static/docson/public/js/widget.js" data-schema="../../../release-package-schema.json"></script>
````{tab-set}

```{tab-item} Release package schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../release-package-schema.json"></script>
```

```{tab-item} Strict release package schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../strict/release-package-schema.json"></script>
```

````

## Reference table

Expand Down
10 changes: 10 additions & 0 deletions docs/schema/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,14 @@ Click on schema elements to expand the tree, or use the '+' icon to expand all e
This page presents the record schema in an interactive browser. You can also download the canonical version of the record schema as [JSON Schema](../../build/current_lang/record-schema.json) or view it as [tables](records_reference).
```

````{tab-set}

```{tab-item} Record schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../record-schema.json"></script>
```

```{tab-item} Strict record schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../strict/record-schema.json"></script>
```

````
10 changes: 10 additions & 0 deletions docs/schema/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,14 @@ Click on schema elements to expand the tree, or use the '+' icon to expand all e
This page presents the release schema in an interactive browser. You can also download the canonical version of the release schema as [JSON Schema](../../build/current_lang/release-schema.json), download it as a [CSV spreadsheet](../../build/current_lang/release-schema.csv), view it as [tables](reference), or access it through the [Field-Level Mapping Template](https://www.open-contracting.org/resources/ocds-field-level-mapping-template/).
```

````{tab-set}

```{tab-item} Release schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../release-schema.json"></script>
```

```{tab-item} Strict release schema
<script src="../../_static/docson/public/js/widget.js" data-schema="../../../release-schema.json"></script>
```

````