Add planning final status fields and codelist (#1642)

* release-schema: Add planning final status * schema/codelists/planningFinalStatus.csv: Add examples to descriptions * Update changelog * Apply suggestions from code review Co-authored-by: odscjen <95221058+odscjen@users.noreply.github.com> * build: Run manage.py pre-commit * changelog: Fill in missing new codelists. Remove unnecessary commas. * schema: Reword planningFinalStatus descriptions. Add planning.finalStatusDetails. Remove object name from field names. Order array fields last. --------- Co-authored-by: odscjen <95221058+odscjen@users.noreply.github.com> Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com>
open-contracting · May 7, 2024 · 6249189 · 6249189
1 parent 30be844
commit 6249189
Show file tree

Hide file tree

Showing 5 changed files with 151 additions and 4 deletions.
diff --git a/docs/history/changelog.md b/docs/history/changelog.md
@@ -71,9 +71,16 @@ Per the [normative and non-normative content and changes policy](../governance/n
 ### Codelists
 
 * Add new codelists:
+  * [#1372](https://github.com/open-contracting/standard/pull/1372) `country`
   * [#1316](https://github.com/open-contracting/standard/pull/1316) `language`
+  * [#1326](https://github.com/open-contracting/standard/pull/1326) `linkRelationType`
   * [#1308](https://github.com/open-contracting/standard/pull/1308) `mediaType`
   * [#1459](https://github.com/open-contracting/standard/pull/1459) `partyScale`
+  * [#1654](https://github.com/open-contracting/standard/pull/1654) `permission`
+  * [#1642](https://github.com/open-contracting/standard/pull/1642) `planningFinalStatus`
+  * [#1648](https://github.com/open-contracting/standard/pull/1648) `tenderFinalStatus`
+  * [#1648](https://github.com/open-contracting/standard/pull/1648) `awardFinalStatus`
+  * [#1648](https://github.com/open-contracting/standard/pull/1648) `contractFinalStatus`
 
 * `classificationScheme.csv`:
   * [#1319](https://github.com/open-contracting/standard/pull/1319) Rename from `itemClassificationScheme.csv`.
@@ -155,7 +162,7 @@ Per the [normative and non-normative content and changes policy](../governance/n
 
 * `releaseTag.csv`:
   * [#1238](https://github.com/open-contracting/standard/pull/1238) Open the `releaseTag` codelist.
-  * [#1415](https://github.com/open-contracting/standard/pull/1415), [#1509](https://github.com/open-contracting/standard/pull/1509) Align descriptions of 'planning', 'tender', 'award' and 'contract' with the corresponding schema fields.
+  * [#1415](https://github.com/open-contracting/standard/pull/1415) [#1509](https://github.com/open-contracting/standard/pull/1509) Align descriptions of 'planning', 'tender', 'award' and 'contract' with the corresponding schema fields.
 
 * `tenderStatus`, `awardStatus` and `contractStatus`:
   * [#1509](https://github.com/open-contracting/standard/pull/1509) [#1658](https://github.com/open-contracting/standard/pull/1658) Clarify semantics and deprecate codes.
@@ -188,6 +195,7 @@ Per the [normative and non-normative content and changes policy](../governance/n
 
 * Add new fields:
   * [#1335](https://github.com/open-contracting/standard/pull/1335) `planning.id`
+  * [#1642](https://github.com/open-contracting/standard/pull/1642) `planning.finalStatus`, `planning.finalStatusDetails` and `planning.finalStatusDate`
   * [#1324](https://github.com/open-contracting/standard/pull/1324) `tender.datePublished`
   * [#1296](https://github.com/open-contracting/standard/pull/1296) [#1674](https://github.com/open-contracting/standard/pull/1674) `tender.exclusionGrounds`
   * [#1669](https://github.com/open-contracting/standard/pull/1669) `tender.expressionOfInterestDeadline`
@@ -205,7 +213,7 @@ Per the [normative and non-normative content and changes policy](../governance/n
     * `contracts.estimatedValue`
   * [#1459](https://github.com/open-contracting/standard/pull/1459) `Organization.details.scale`
   * [#1326](https://github.com/open-contracting/standard/pull/1326) [#1431](https://github.com/open-contracting/standard/pull/1431) `links`
-  * [#1376](https://github.com/open-contracting/standard/pull/1376), [#1489](https://github.com/open-contracting/standard/pull/1489) `publisher`
+  * [#1376](https://github.com/open-contracting/standard/pull/1376) [#1489](https://github.com/open-contracting/standard/pull/1489) `publisher`
   * [#1372](https://github.com/open-contracting/standard/pull/1372) `Address.country`
   * [#1380](https://github.com/open-contracting/standard/pull/1380) [#1440](https://github.com/open-contracting/standard/pull/1440) `Document.languages`
   * [#1439](https://github.com/open-contracting/standard/pull/1439) `Document.relatedItems`
@@ -478,7 +486,7 @@ See the changelogs for:
 
 ### Schema
 
-* [#603](https://github.com/open-contracting/standard/issues/603), [#645](https://github.com/open-contracting/standard/issues/645) Add definitions to `Release`, `planning.budget`, `Milestone`, `Organization.address`, `Organization.contactPoint`, `Classification`, `Identifier`, `Value` and `Period`.
+* [#603](https://github.com/open-contracting/standard/issues/603) [#645](https://github.com/open-contracting/standard/issues/645) Add definitions to `Release`, `planning.budget`, `Milestone`, `Organization.address`, `Organization.contactPoint`, `Classification`, `Identifier`, `Value` and `Period`.
 * [#578](https://github.com/open-contracting/standard/issues/578) Update the definition of the `buyer` field to cover goods, works and services, and multiple buyers.
 
 ### Documentation
@@ -489,7 +497,7 @@ See the changelogs for:
 
 ### Extensions
 
-* [#40](https://github.com/open-contracting/ocds-extensions/issues/40), [#43](https://github.com/open-contracting/ocds-extensions/issues/43), [#47](https://github.com/open-contracting/ocds-extensions/issues/47) Add missing definitions, codelists and enums to core extensions, correct typos in codelist filenames, disallow use of `null` as an item in arrays, disallow required fields from being set to `null`, allow optional fields to be `null`, use `OrganizationReference` instead of `Organization`.
+* [#40](https://github.com/open-contracting/ocds-extensions/issues/40) [#43](https://github.com/open-contracting/ocds-extensions/issues/43) [#47](https://github.com/open-contracting/ocds-extensions/issues/47) Add missing definitions, codelists and enums to core extensions, correct typos in codelist filenames, disallow use of `null` as an item in arrays, disallow required fields from being set to `null`, allow optional fields to be `null`, use `OrganizationReference` instead of `Organization`.
 
 ## [1.1.2] - 2017-11-10
 

diff --git a/schema/codelists/planningFinalStatus.csv b/schema/codelists/planningFinalStatus.csv
@@ -0,0 +1,3 @@
+Code,Title,Description
+cancelled,Cancelled,"The planning process was cancelled by the buyer or the procuring entity (for example, because of a change in needs, insufficient funds, or technical or procedural errors) before any contracting process was planned successfully."
+unsuccessful,Unsuccessful,"The planning process failed (for example, because stakeholders rejected the proposed purchase) before any contracting process was planned successfully."
diff --git a/schema/dereferenced-release-schema.json b/schema/dereferenced-release-schema.json
@@ -1584,6 +1584,38 @@
             }
           }
         },
+        "finalStatus": {
+          "title": "Final status",
+          "description": "The final status of the planning process, using the closed [planningFinalStatus](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#planning-final-status) codelist.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "codelist": "planningFinalStatus.csv",
+          "openCodelist": false,
+          "enum": [
+            "cancelled",
+            "unsuccessful",
+            null
+          ]
+        },
+        "finalStatusDetails": {
+          "title": "Final status details",
+          "description": "Additional details on the final status of the planning process. This field can be used to provide the local name of the final status.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "finalStatusDate": {
+          "title": "Final status date",
+          "description": "The date on which the planning process reached its final status.",
+          "format": "date-time",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "documents": {
           "title": "Documents",
           "description": "Documents related to the planning process (for example, notices, needs assessments and market studies).",
@@ -14624,6 +14656,38 @@
             }
           }
         },
+        "finalStatus": {
+          "title": "Final status",
+          "description": "The final status of the planning process, using the closed [planningFinalStatus](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#planning-final-status) codelist.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "codelist": "planningFinalStatus.csv",
+          "openCodelist": false,
+          "enum": [
+            "cancelled",
+            "unsuccessful",
+            null
+          ]
+        },
+        "finalStatusDetails": {
+          "title": "Final status details",
+          "description": "Additional details on the final status of the planning process. This field can be used to provide the local name of the final status.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "finalStatusDate": {
+          "title": "Final status date",
+          "description": "The date on which the planning process reached its final status.",
+          "format": "date-time",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "documents": {
           "title": "Documents",
           "description": "Documents related to the planning process (for example, notices, needs assessments and market studies).",

diff --git a/schema/release-schema.json b/schema/release-schema.json
@@ -163,6 +163,38 @@
           "description": "Details of the budget that will fund the future contract(s)",
           "$ref": "#/definitions/Budget"
         },
+        "finalStatus": {
+          "title": "Final status",
+          "description": "The final status of the planning process, using the closed [planningFinalStatus](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#planning-final-status) codelist.",
+          "type": [
+            "string",
+            "null"
+          ],
+          "codelist": "planningFinalStatus.csv",
+          "openCodelist": false,
+          "enum": [
+            "cancelled",
+            "unsuccessful",
+            null
+          ]
+        },
+        "finalStatusDetails": {
+          "title": "Final status details",
+          "description": "Additional details on the final status of the planning process. This field can be used to provide the local name of the final status.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "finalStatusDate": {
+          "title": "Final status date",
+          "description": "The date on which the planning process reached its final status.",
+          "format": "date-time",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "documents": {
           "title": "Documents",
           "description": "Documents related to the planning process (for example, notices, needs assessments and market studies).",

diff --git a/schema/versioned-release-validation-schema.json b/schema/versioned-release-validation-schema.json
@@ -126,6 +126,46 @@
         "budget": {
           "$ref": "#/definitions/Budget"
         },
+        "finalStatus": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "releaseDate": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "releaseID": {
+                "type": "string"
+              },
+              "value": {
+                "type": [
+                  "string",
+                  "null"
+                ],
+                "codelist": "planningFinalStatus.csv",
+                "openCodelist": false,
+                "enum": [
+                  "cancelled",
+                  "unsuccessful",
+                  null
+                ]
+              },
+              "releaseTag": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "finalStatusDetails": {
+          "$ref": "#/definitions/StringNullVersioned"
+        },
+        "finalStatusDate": {
+          "$ref": "#/definitions/StringNullDateTimeVersioned"
+        },
         "documents": {
           "type": "array",
           "items": {