Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ImmediateContainer, Quantity and SimplyUnit, clarify Unit use #1689

Merged
merged 16 commits into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 20 additions & 0 deletions docs/examples/release_schema_reference/release_package.json
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,26 @@
"currency": "GBP"
}
}
},
{
"id": "0002",
"description": "Paint for road markings",
"classification": {
"scheme": "CPV",
"id": "44811000",
"description": "Road paint",
"uri": "http://cpv.data.ac.uk/code-44811000"
},
"immediateContainer": {
"name": "Can/Tin",
"capacity": {
"unit": {
"scheme": "UNCEFACT",
"id": "GLI"
},
"value": "[100,100]"
}
}
}
],
"value": {
Expand Down
25 changes: 22 additions & 3 deletions docs/schema/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,11 +537,11 @@ The items block is used to list the line-items associated with a tender, award o

#### Unit

The `unit` block allows detailed specification of the parameters and price of units that make up a line-item.
The `unit` block allows detailed specification of the parameters and price of units that make up a line-item. It should be used for units of measurement only. For units of presentation it is recommended to use the `ImmediateContainer` subschema.
odscjen marked this conversation as resolved.
Show resolved Hide resolved

If the [Quantities, Units, Dimensions and Data Types Ontologies](https://www.qudt.org) unit classification scheme is used, then publishers can use its CamelCase unit names, such as "SquareMile", in the `unit.name` field.
If the [Quantities, Units, Dimensions and Data Types Ontologies](https://www.qudt.org) unit classification scheme is used, then publishers may use its CamelCase unit names, such as "SquareMile", in the `unit.name` field.

Other unit classification schemes can be used, including those in the [unitClassificationScheme codelist](codelists.md#unit-classification-scheme).
Other unit classification schemes may be used, including those in the [unitClassificationScheme codelist](codelists.md#unit-classification-scheme).

````{admonition} Example
:class: hint
Expand All @@ -558,6 +558,25 @@ Other unit classification schemes can be used, including those in the [unitClass
:collapse: value
```

#### ImmediateContainer

The `ImmediateContainer` subschema allows detailed specification of the immediate container of an item. This is also known as the presentation, the presentation form, the package. For units of measurement it is recommended to use the `Unit` subschema.
odscjen marked this conversation as resolved.
Show resolved Hide resolved

````{admonition} Example
:class: hint

```{jsoninclude} ../examples/release_schema_reference/release_package.json
:jsonpointer: /releases/0/tender/items/1
:expand: immediateContainer
:title: immediateContainer
```
````

```{jsonschema} ../../build/current_lang/release-schema.json
:pointer: /definitions/Item/properties/immediateContainer
:collapse: capacity
```

### Classification

````{admonition} Example
Expand Down
Loading
Loading