Skip to content

Commit

Permalink
docs/schema/reference.md: Move worked example lists above jsonschema …
Browse files Browse the repository at this point in the history
…directives
  • Loading branch information
duncandewhurst committed Dec 23, 2024
1 parent 31bd40b commit 103b771
Showing 1 changed file with 35 additions and 36 deletions.
71 changes: 35 additions & 36 deletions docs/schema/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ A release describes a single contracting or planning process at a particular poi
:title: release
```
````
```{workedexamplelist} The following worked examples are available for releases
:tag: release
```

Each release has the following fields:

Expand All @@ -79,10 +82,6 @@ Each release has the following fields:
:list: release
```

```{workedexamplelist} The following worked examples are available for releases
:tag: release
```

### Parties

Each of the organizations referenced in a release must be included in the parties section.
Expand All @@ -108,6 +107,10 @@ An `Organization` is defined as:
```
````

```{workedexamplelist} The following worked examples are available for organizations
:tag: parties
```

Each `Organization` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -125,10 +128,6 @@ Each organization has a `details` object. Through extensions, this can be used t
:list: partyDetail
```

```{workedexamplelist} The following worked examples are available for organizations
:tag: parties
```

### Planning

The `planning` object is defined as:
Expand All @@ -147,6 +146,10 @@ Background documents such as feasibility studies and project plans can also be i
```
````

```{workedexamplelist} The following worked examples are available for planning
:tag: planning
```

`planning` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -158,10 +161,6 @@ Background documents such as feasibility studies and project plans can also be i
:list: planning
```

```{workedexamplelist} The following worked examples are available for planning
:tag: planning
```

#### Budget

Apart from documents, the majority of planning information is held within the `planning/budget` object. This is designed to allow both machine-readable linkable data about budgets, cross-referencing to data held in other standards such as the [Fiscal Data Package](https://specs.frictionlessdata.io/fiscal-data-package/) or [International Aid Transparency Initiative Standard](https://iatistandard.org/en/), and human readable description of the related budgets and projects, supporting users to understand the relationship of the contracting (or planning) process to existing projects and budgets even where linked data is not available.
Expand Down Expand Up @@ -234,6 +233,10 @@ The `tender` object is defined as:
```
````

```{workedexamplelist} The following worked examples are available for tenders
:tag: tender
```

Each `tender` object has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -245,10 +248,6 @@ Each `tender` object has the following fields:
:list: tender
```

```{workedexamplelist} The following worked examples are available for tenders
:tag: tender
```

### Bids

The [Bid statistics and details](https://extensions.open-contracting.org/en/extensions/bids/v1.1.4/) extension can be used to provide bid statistics and detailed information about individual bids.
Expand Down Expand Up @@ -276,6 +275,10 @@ An `Award` is defined as:
```
````

```{workedexamplelist} The following worked examples are available for awards
:tag: award
```

Each `Award` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -287,10 +290,6 @@ Each `Award` has the following fields:
:list: award
```

```{workedexamplelist} The following worked examples are available for awards
:tag: award
```

### Contract

The contract section is used to provide details of contracts that have been entered into. Every contract must have a related award, linked via the `awardID` field. This is because supplier information is contained within the 'award'.
Expand All @@ -314,6 +313,10 @@ A `Contract` is defined as:
```
````

```{workedexamplelist} The following worked examples are available for contracts
:tag: contract
```

Each `Contract` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -325,10 +328,6 @@ Each `Contract` has the following fields:
:list: contract
```

```{workedexamplelist} The following worked examples are available for contracts
:tag: contract
```

### Implementation

Implementation information can be updated over the course of a contract. It belongs nested within the contract it relates to.
Expand All @@ -347,6 +346,10 @@ The `contracts/implementation` object is defined as:
```
````

```{workedexamplelist} The following worked examples are available for implementations
:tag: implementation
```

Each `contracts/implementation` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
Expand All @@ -360,10 +363,6 @@ Each `contracts/implementation` has the following fields:

Information on subcontracts is not currently included in the core OCDS schema, but might be handled by [proposed extensions](conformance_and_extensions)

```{workedexamplelist} The following worked examples are available for implementations
:tag: implementation
```

#### Transaction

Transactions can be used to represent actual flows of money between organizations in relation to a contract. As with the [budget](#budget) block, transactions can reference a third-party `source` of data, and ought to reuse identifiers from that source.
Expand Down Expand Up @@ -436,17 +435,17 @@ An `Amendment` is defined as:
```
````

```{workedexamplelist} The following worked examples are available for amendments
:tag: amendment
```

Each `Amendment` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Amendment
:collapse: changes
```

```{workedexamplelist} The following worked examples are available for amendments
:tag: amendment
```

#### Changes

```{deprecated} 1.1
Expand Down Expand Up @@ -776,17 +775,17 @@ A `Milestone` is defined as:
```
````

```{workedexamplelist} The following worked examples are available for milestones
:tag: milestone
```

Each `Milestone` has the following fields:

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Milestone
:collapse: documents
```

```{workedexamplelist} The following worked examples are available for milestones
:tag: milestone
```

### Value

A `Value` is defined as:
Expand Down

0 comments on commit 103b771

Please sign in to comment.