Merge branch '1.2-dev' into 229-translations

open-contracting · Dec 4, 2023 · 2a26cfa · 2a26cfa
2 parents 96249d4 + 096e4cf
commit 2a26cfa
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 30 deletions.
diff --git a/docs/examples/release_schema_reference/release_package.json b/docs/examples/release_schema_reference/release_package.json
@@ -216,7 +216,7 @@
           {
             "id": "0001",
             "documentType": "tenderNotice",
-            "title": "Enquiry Responses",
+            "title": "Tender notice",
             "description": "Tender Notice",
             "url": "http://example.com/tenderNotice/ocds-213czf-000-00001-01.html",
             "datePublished": "2010-03-20T11:30:15Z",

diff --git a/docs/guidance/map.md b/docs/guidance/map.md
@@ -142,6 +142,10 @@ For example, you have created an extension to add a new field to indicate whethe
 map/extensions
 ```
 
+## Link OCDS with alternative representations
+
+The data contained in an OCDS release is often available in other formats, such as the HTML or PDF version of a notice. You ought to link to these alternative representations from your OCDS data, so that users can follow up on contracting processes that they are interested in: for example, to submit a bid, or to subscribe to notifications. For more information on linking to alternative representations, refer to the [`Document` reference](../schema/reference.md#document).
+
 ## Link OCDS with other standards
 
 Not all information that is related to a contracting (or planning) process belongs in OCDS. For example, a company's annual filings and incorporation status are typically managed in a company registry, outside the lifecycle of a contracting process.

diff --git a/docs/history/changelog.md b/docs/history/changelog.md
@@ -210,6 +210,7 @@ Per the [normative and non-normative content and changes policy](../governance/n
   * [#1389](https://github.com/open-contracting/standard/pull/1389) `initiationType`, because the approach to data modelling that it supports was not pursued.
   * [#1380](https://github.com/open-contracting/standard/pull/1380) `Document.language` in favor of the new `Document.languages` field, to support documents in which multiple languages are used.
   * [#1509](https://github.com/open-contracting/standard/pull/1509) `tender.status`, `Award.status`, `Contract.status`, because the same information can be provided by filling in the relevant date fields.
+  * [#1662](https://github.com/open-contracting/standard/pull/1662) `Transaction.source`, because its value would be potentially identical across every transaction.
 
 * Update and clarify field descriptions:
   * [#1113](https://github.com/open-contracting/standard/pull/1113) `ocid`, to recommend a hyphen after the ocid prefix.
@@ -228,6 +229,7 @@ Per the [normative and non-normative content and changes policy](../governance/n
   * [#1618](https://github.com/open-contracting/standard/pull/1618) Normalize field descriptions according to a style guide.
   * [#1656](https://github.com/open-contracting/standard/pull/1656) `Award.value` and `Contract.value`, to clarify with respect to changes in contract values.
   * [#1509](https://github.com/open-contracting/standard/pull/1509) `planning`, `Planning`, `tender` and `Tender` to clarify relationships with the availability of documents.
+  * [#1663](https://github.com/open-contracting/standard/pull/1663) `tender.amendments`, `awards.amendments`, `contracts.amendments` to avoid restating field titles.
 
 * Remove confusing terminology:
   * [#1487](https://github.com/open-contracting/standard/pull/1487) `planning.budget.project`, to remove sentence about translation options.
@@ -295,25 +297,33 @@ Per the [normative and non-normative content and changes policy](../governance/n
 
 ### Documentation
 
-* [#1094](https://github.com/open-contracting/standard/pull/1094) Add guidance on populating `Organization.id` for parties without an organization identifier.
 * [#1115](https://github.com/open-contracting/standard/pull/1115) Add guidance on when having multiple suppliers per award.
 * [#1161](https://github.com/open-contracting/standard/pull/1161) Change recommendation for unknown time component.
-* [#1189](https://github.com/open-contracting/standard/pull/1189) Add recommendations about publishing and referencing documents in the document reference section.
 * [#1208](https://github.com/open-contracting/standard/pull/1208) Update guidance with new field definitions.
 * [#1216](https://github.com/open-contracting/standard/pull/1216) Update definitions of contracting process, record, and ocid. Introduce definition of planning process.
-* [#1307](https://github.com/open-contracting/standard/pull/1307) Clarify uniqueness rules for records.
-* [#1315](https://github.com/open-contracting/standard/pull/1315) Add rules on setting `id` and `date` for compiled releases to the merging specification.
-* [#1344](https://github.com/open-contracting/standard/pull/1344) Add contract suspension worked example.
-* [#1375](https://github.com/open-contracting/standard/pull/1375) Update guidance for empty fields in the merging documentation.
-* [#1466](https://github.com/open-contracting/standard/pull/1466) Reference worked examples in release and record reference documentation.
-* [#1466](https://github.com/open-contracting/standard/pull/1482) Add examples in release reference documentation.
-* [#1618](https://github.com/open-contracting/standard/pull/1618) Add conformance rule about normative statements.
-* [#1618](https://github.com/open-contracting/standard/pull/1618) Remove validator and application conformance rules.
 * [#1618](https://github.com/open-contracting/standard/pull/1618) Move governance policies from Google Docs, updating references for OCDS 1.1.5 and OCDS 1.2.0, and removing references to GitHub issues.
-* [#1643](https://github.com/open-contracting/standard/pull/1643) Update identifier section in release reference.
-* [#1655](https://github.com/open-contracting/standard/pull/1655) Rewrite identifiers reference and examples for clarity.
-* [#1659](https://github.com/open-contracting/standard/pull/1659) Add `Record` definition schema table to record reference.
-* [#1665](https://github.com/open-contracting/standard/pull/1665) Add translations worked example.
+* Records
+  * [#1307](https://github.com/open-contracting/standard/pull/1307) Clarify uniqueness rules for records.
+  * [#1659](https://github.com/open-contracting/standard/pull/1659) Add `Record` definition schema table to record reference.
+* Merging
+  * [#1315](https://github.com/open-contracting/standard/pull/1315) Add rules on setting `id` and `date` for compiled releases to the merging specification.
+  * [#1375](https://github.com/open-contracting/standard/pull/1375) Update guidance for empty fields in the merging documentation.
+* Identifiers
+  * [#1094](https://github.com/open-contracting/standard/pull/1094) Add guidance on populating `Organization.id` for parties without an organization identifier.
+  * [#1643](https://github.com/open-contracting/standard/pull/1643) Update identifier section in release reference.
+  * [#1655](https://github.com/open-contracting/standard/pull/1655) Rewrite identifiers reference and examples for clarity.
+* Documents
+  * [#1189](https://github.com/open-contracting/standard/pull/1189) Add recommendations about publishing and referencing documents in the document reference section.
+  * [#1664](https://github.com/open-contracting/standard/pull/1664) Recommend linking to alternative representations using `documents`.
+* Conformance
+  * [#1618](https://github.com/open-contracting/standard/pull/1618) Add conformance rule about normative statements.
+  * [#1618](https://github.com/open-contracting/standard/pull/1618) Remove validator and application conformance rules.
+* Examples
+  * Add examples:
+    * [#1344](https://github.com/open-contracting/standard/pull/1344) Contract suspension
+    * [#1665](https://github.com/open-contracting/standard/pull/1665) Translations
+  * [#1466](https://github.com/open-contracting/standard/pull/1466) Reference examples in release and record reference documentation.
+  * [#1466](https://github.com/open-contracting/standard/pull/1482) Add examples in release reference documentation.
 
 ## [1.1.5] - 2020-08-20
 

diff --git a/docs/schema/reference.md b/docs/schema/reference.md
@@ -453,6 +453,8 @@ OCDS allows summarizing information in the document's `description` field. Provi
 
 If a document contains multiple languages, use the `languages` field to list the languages used in the document. If there are multiple versions of a document, each in a different language, add a separate `Document` object for each version of the document.
 
+If an alternative representation of the data in an OCDS release exists, a link should be provided in the relevant `.documents` array. For example, if the data in an OCDS award release is also available as an HTML page, a link to the HTML page should be provided in `awards.documents`. Links to alternative representations of an entire contracting process should be provided in `tender.documents`.
+
 ````{admonition} Example
 :class: hint
 

diff --git a/schema/dereferenced-release-schema.json b/schema/dereferenced-release-schema.json
@@ -6003,7 +6003,7 @@
           }
         },
         "amendments": {
-          "description": "A tender amendment is a formal change to the tender, and generally involves the publication of a new tender notice/release. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes to the tender, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -8500,7 +8500,7 @@
             "uniqueItems": true
           },
           "amendments": {
-            "description": "An award amendment is a formal change to the details of the award, and generally involves the publication of a new award notice/release. The rationale and a description of the changes made can be provided here.",
+            "description": "The formal changes to the award, which generally involve the publication of a new notice/release.",
             "type": "array",
             "title": "Amendments",
             "items": {
@@ -10566,7 +10566,11 @@
                         "string",
                         "null"
                       ],
-                      "format": "uri"
+                      "format": "uri",
+                      "deprecated": {
+                        "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+                        "deprecatedVersion": "1.2"
+                      }
                     },
                     "date": {
                       "title": "Date",
@@ -13734,7 +13738,7 @@
             }
           },
           "amendments": {
-            "description": "A contract amendment is a formal change to, or extension of, a contract, and generally involves the publication of a new contract signature notice/release, or some other documents detailing the change. The rationale and a description of the changes made can be provided here.",
+            "description": "The formal changes or extensions to the contract, which generally involve the publication of a new notice/release.",
             "type": "array",
             "title": "Amendments",
             "items": {
@@ -18932,7 +18936,7 @@
           }
         },
         "amendments": {
-          "description": "A tender amendment is a formal change to the tender, and generally involves the publication of a new tender notice/release. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes to the tender, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -21425,7 +21429,7 @@
           "uniqueItems": true
         },
         "amendments": {
-          "description": "An award amendment is a formal change to the details of the award, and generally involves the publication of a new award notice/release. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes to the award, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -23485,7 +23489,11 @@
                       "string",
                       "null"
                     ],
-                    "format": "uri"
+                    "format": "uri",
+                    "deprecated": {
+                      "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+                      "deprecatedVersion": "1.2"
+                    }
                   },
                   "date": {
                     "title": "Date",
@@ -26653,7 +26661,7 @@
           }
         },
         "amendments": {
-          "description": "A contract amendment is a formal change to, or extension of, a contract, and generally involves the publication of a new contract signature notice/release, or some other documents detailing the change. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes or extensions to the contract, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -26870,7 +26878,11 @@
                   "string",
                   "null"
                 ],
-                "format": "uri"
+                "format": "uri",
+                "deprecated": {
+                  "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+                  "deprecatedVersion": "1.2"
+                }
               },
               "date": {
                 "title": "Date",
@@ -30521,7 +30533,11 @@
             "string",
             "null"
           ],
-          "format": "uri"
+          "format": "uri",
+          "deprecated": {
+            "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+            "deprecatedVersion": "1.2"
+          }
         },
         "date": {
           "title": "Date",

diff --git a/schema/release-schema.json b/schema/release-schema.json
@@ -517,7 +517,7 @@
           }
         },
         "amendments": {
-          "description": "A tender amendment is a formal change to the tender, and generally involves the publication of a new tender notice/release. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes to the tender, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -664,7 +664,7 @@
           "uniqueItems": true
         },
         "amendments": {
-          "description": "An award amendment is a formal change to the details of the award, and generally involves the publication of a new award notice/release. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes to the award, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -835,7 +835,7 @@
           }
         },
         "amendments": {
-          "description": "A contract amendment is a formal change to, or extension of, a contract, and generally involves the publication of a new contract signature notice/release, or some other documents detailing the change. The rationale and a description of the changes made can be provided here.",
+          "description": "The formal changes or extensions to the contract, which generally involve the publication of a new notice/release.",
           "type": "array",
           "title": "Amendments",
           "items": {
@@ -1225,7 +1225,11 @@
             "string",
             "null"
           ],
-          "format": "uri"
+          "format": "uri",
+          "deprecated": {
+            "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+            "deprecatedVersion": "1.2"
+          }
         },
         "date": {
           "title": "Date",

diff --git a/schema/versioned-release-validation-schema.json b/schema/versioned-release-validation-schema.json
@@ -1378,7 +1378,36 @@
           "minLength": 1
         },
         "source": {
-          "$ref": "#/definitions/StringNullUriVersioned"
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "releaseDate": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "releaseID": {
+                "type": "string"
+              },
+              "value": {
+                "type": [
+                  "string",
+                  "null"
+                ],
+                "format": "uri",
+                "deprecated": {
+                  "description": "This field is deprecated, because its value would be potentially identical across every transaction.",
+                  "deprecatedVersion": "1.2"
+                }
+              },
+              "releaseTag": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
         },
         "date": {
           "$ref": "#/definitions/StringNullDateTimeVersioned"