Merge pull request #3 from open-contracting/various-updates

RelatedLots -> RelatedLot (singular)
open-contracting-extensions · Apr 11, 2017 · 108965a · 108965a
2 parents bac216d + d17806b
commit 108965a
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -3,28 +3,29 @@ Lots
 
 When a single tender is broken down into parts that can be bid upon, and awarded, separately, this is modelled using the **lots extension**.
 
-The lots extension maintains the overall structure of an OCDS release, with items, documents and milestones nested immediately within ```tender```, ```award``` and ```contract``` items, but it introduces an array of Lots in the ```tender``` section, and the ability to cross-reference the ```relatedLots``` for items, documents, milestones and awards. 
+The lots extension maintains the overall structure of an OCDS release, with items, documents and milestones nested immediately within ```tender```, ```award``` and ```contract``` items, but it introduces an array of Lots in the ```tender``` section, and the ability to cross-reference a specific ```relatedLot``` for each item, and an array of ```relatedLots``` for documents, milestones and awards. 
 
-Optional ```lotDetails``` and ```lotGroups``` section allow more complex conditions around the award of lots to be expressed, such as the maximum value of group of lots. 
+Optional ```lotDetails``` and ```lotGroups``` section allow more complex conditions around the award of lots to be expressed, such as the maximum value of a group of lots. 
 
 This means that systems which are not 'lot aware' can still understand the overall value of contracting taking place, key events, and relationships between buyers and suppliers. At the same time, 'lot aware' systems can make use of the cross-referenced information to present a lot-centric view on the information to users, or to analyse contracting lot by lot. 
 
 ## Related Lot
 
-The relatedLot property is available for:
+The ```relatedLot``` (singular) property is available for:
 
 * items 
+
+An array of ```relatedLots``` (plural) can be provided for each of:
+
 * documents
 * milestones
-* awards
-
-It is provided as an **array** of lot identifiers. 
+* awards 
 
-When lots are used, **all** items should have a ```relatedLots``` property.
+When lots are used, **all** items should have a ```relatedLot``` property.
 
 Documents and milestones can optionally have a ```relatedLots``` property. Those without this property should be interpreted as applicable to the tender as a whole. 
 
-The items within an award should each have a ```relatedLots``` property, but publishers may choose to also reference all the lots an award relates to at the award level. 
+The items within an award should each have a ```relatedLot``` property, but publishers may choose to also reference all the lots an award relates to at the award level using ```relatedLots```
 
 Where the bid extension is also in use, each bid can also declare its related lots. 
 
@@ -79,7 +80,7 @@ Although part of the same tender, the buyer is willing to award these different
               "id": "71210000",
               "description": "Advisory architectural services"
             },
-            "relatedLot":["lot-1"]
+            "relatedLot":"lot-1"
            },
            {
             "id": "0002",
@@ -89,7 +90,7 @@ Although part of the same tender, the buyer is willing to award these different
               "id": "71220000",
               "description": "Architectural design services"
             },
-            "relatedLot":["lot-1"]
+            "relatedLot":"lot-1"
            },
            {
             "id": "0003",
@@ -99,7 +100,7 @@ Although part of the same tender, the buyer is willing to award these different
               "id": "71311000",
               "description": "Civil engineering consultancy services"
             },
-            "relatedLot":["lot-2"]
+            "relatedLot":"lot-2"
            },
            {
             "id": "0004",
@@ -109,7 +110,7 @@ Although part of the same tender, the buyer is willing to award these different
               "id": "71312000",
               "description": "Structural engineering consultancy services"
             },
-            "relatedLot":["lot-1"]
+            "relatedLot":"lot-1"
            }
         ],
         "value": {
@@ -150,7 +151,7 @@ Although part of the same tender, the buyer is willing to award these different
         ],
         "lotGroups":[{
             "id":"lot-group-1",
-            "relatedLot":["lot-2","lot-3"],
+            "relatedLots":["lot-2","lot-3"],
             "optionToCombine":true,
             "maximumValue":1000000
         }],

diff --git a/release-schema.json b/release-schema.json
@@ -4,7 +4,7 @@
       "properties": {
         "lots": {
           "title": "Lots",
-          "description": "A tender process may be divided into lots, where bidders can bid on one or more lots. Details of each lot can be provided here. Items, documents and other features can then reference the lot they are related to using relatedLot. Where no relatedLot identifier is given, the values should be interpreted as applicable to the whole tender. Properties of tender can be overridden for a given Lot through their inclusion in the Lot object.",
+          "description": "A tender process may be divided into lots, where bidders can bid on one or more lots. Details of each lot can be provided here. Items, documents and other features can then reference the lot they are related to using relatedLot. Where no relatedLots identifier is given, the values should be interpreted as applicable to the whole tender. Properties of tender can be overridden for a given Lot through their inclusion in the Lot object.",
           "type": "array",
           "items": {
             "$ref": "#/definitions/Lot"
@@ -15,7 +15,7 @@
         },
         "lotGroups": {
           "title": "Lot groups",
-          "description": "ere the buyer reserves the right to combine lots, or wishes to specify the total value for a group of lots, a lot group is used to capture this information.",
+          "description": "Where the buyer reserves the right to combine lots, or wishes to specify the total value for a group of lots, a lot group is used to capture this information.",
           "type":"array",
           "items":{
             "$ref": "#/definitions/LotGroup"
@@ -42,18 +42,13 @@
     },
     "Item": {
       "properties": {
-        "relatedLots": {
-          "title": "Related lot(s)",
-          "description": "If this item belongs to a lot, provide the identifier(s) of the related lot(s) here.",
+        "relatedLot": {
+          "title": "Related lot",
+          "description": "If this item belongs to a lot, provide the identifier of the related lot here. Each item may only belong to a single lot.",
           "type": [
-            "array"
-          ],
-          "items": {
-            "type": [
-              "string",
-              "null"
-            ]
-          }
+            "string",
+            "null"
+          ]
         }
       }
     },
@@ -117,7 +112,7 @@
         "id": {
           "title": "Lot ID",
           "type": "string",
-          "description": "A local identifier for this lot, such as a lot number. This is used in relatedLot references at the item, document and award level."
+          "description": "A local identifier for this lot, such as a lot number. This is used in relatedLots references at the item, document and award level."
         },
         "title": {
           "title": "Title",