Skip to content

Commit

Permalink
add Location and Project to examples release_package.json and schema/…
Browse files Browse the repository at this point in the history
…reference
  • Loading branch information
odscjen committed Apr 11, 2024
1 parent 4b967f5 commit 2675f20
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 3 deletions.
41 changes: 41 additions & 0 deletions docs/examples/release_schema_reference/release_package.json
Expand Up @@ -94,6 +94,47 @@
"projectID": "SP001",
"uri": "https://openspending.org/uk-barnet-budget/entries/6801ad388f3a38b7740dde20108c58b35984ee91"
},
"project": {
"id": "oc4ids-bu3kcz-0000",
"title": "Central Junction Cycle Lane Construction",
"description": "Design, construction and supervision of a new cycle lane for the Central Junction.",
"totalValue": {
"amount": 1100000,
"currency": "GBP"
},
"uri": "http://example.com/projects/oc4ids-bu3kcz-0000.json",
"sector": {
"id": "transport.road",
"description": "Road transport, including roads, highways, streets, tunnels and bridges.",
"scheme": "oc4idsProjectSector"
},
"additionalClassifications": [
{
"id": "03.04.05",
"description": "Cycle lanes for road transport.",
"scheme": "My local scheme"
}
],
"locations": [
{
"description": "Barnet, London, UK",
"geometry": {
"type": "Point",
"coordinates": [
51.605,
0.2076
]
},
"gazetteer": {
"scheme": "GEONAMES",
"identifier": [
"2656295"
]
},
"uri": "https://www.geonames.org/2656295/barnet.html"
}
]
},
"documents": [
{
"datePublished": "2009-01-05T00:00:00Z",
Expand Down
41 changes: 38 additions & 3 deletions docs/schema/reference.md
Expand Up @@ -122,7 +122,7 @@ Each organization has a `details` object. Through extensions, this can be used t

### Planning

The planning section is used in a planning process. This includes information about, for example, needs identification, budget planning and market research. Background documents such as feasibility studies and project plans can also be included in this section.
The planning section is used in a planning process. This includes information about, for example, needs identification, budget planning, the parent project and market research. Background documents such as feasibility studies and project plans can also be included in this section.

````{admonition} Example
:class: hint
Expand All @@ -135,7 +135,7 @@ The planning section is used in a planning process. This includes information ab

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Planning
:collapse: budget,documents,milestones
:collapse: budget,project,documents,milestones
```

```{extensionlist} The following extensions are available for planning
Expand Down Expand Up @@ -168,6 +168,28 @@ Apart from documents, the majority of planning information is held within the bu
:list: budget
```

#### Project

The `planning` object includes details of the infrastructure or public-private partnership (PPP) project to which a planning process is related. The identifier of the project ought to be disclosed in `planning.project.id`. This object is designed to allow both machine-readable linkable data about the parent project, cross-referencing to data held in other standards such as the [Open Contracting for Infrastructure Data Standards Toolkit (OC4IDS)](https://standard.open-contracting.org/infrastructure/latest/en/projects/#what-is-a-project) and the [OCDS for PPPs](https://standard.open-contracting.org/profiles/ppp/latest/en/) profile, and human readable description of the parent project, supporting users to understand the relationship of the contracting (or planning) process to their parent project even where linked data is not available.

````{admonition} Example
:class: hint
```{jsoninclude} ../examples/release_schema_reference/release_package.json
:jsonpointer: /releases/0/planning/project
:title: project
```
````

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Project
:collapse: totalValue,additionalClassifications,locations
```

```{extensionlist} The following extensions are available for project
:list:
```

### Tender

The tender section includes details of the announcement that an organization intends to source some particular goods, services or works and to establish one or more contract(s) for these.
Expand Down Expand Up @@ -671,7 +693,20 @@ As well as providing this machine-readable link between processes, publishers ma

### Location

The [Location](https://extensions.open-contracting.org/en/extensions/location/v1.1.4/) extension can be used to provide location information.
The `Location` subschema can be used to provide the geographic coordinates or standardized location identifiers of the proposed or executed contract delivery in the `Project`, `tender` and `Item` objects.

````{admonition} Example
:class: hint
```{jsoninclude} ../examples/release_schema_reference/release_package.json
:jsonpointer: /releases/0/planning/project/locations/0
:title: location
```
````

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Location
```

### Link

Expand Down

0 comments on commit 2675f20

Please sign in to comment.