From f9b313804379c4419c2bdacd40f2fe2091535144 Mon Sep 17 00:00:00 2001
From: James McKinney <26463+jpmckinney@users.noreply.github.com>
Date: Fri, 3 May 2024 23:35:57 -0400
Subject: [PATCH] schema: Reword planningFinalStatus descriptions. Add
 planning.finalStatusDetails. Remove object name from field names. Order array
 fields last.

---
 docs/history/changelog.md                |  2 +-
 schema/codelists/planningFinalStatus.csv |  4 +--
 schema/release-schema.json               | 44 ++++++++++++++----------
 3 files changed, 29 insertions(+), 21 deletions(-)

diff --git a/docs/history/changelog.md b/docs/history/changelog.md
index aa8ff8e1a..8b8af5baf 100644
--- a/docs/history/changelog.md
+++ b/docs/history/changelog.md
@@ -195,7 +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` and `planning.finalStatusDate`
+  * [#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`
diff --git a/schema/codelists/planningFinalStatus.csv b/schema/codelists/planningFinalStatus.csv
index 65b1e8fc4..abdeb88bd 100644
--- a/schema/codelists/planningFinalStatus.csv
+++ b/schema/codelists/planningFinalStatus.csv
@@ -1,3 +1,3 @@
 Code,Title,Description
-cancelled,Cancelled,"The planning process was cancelled and did not yield a contracting process. For example, a buyer did not go ahead with planned consultations about the construction of a new recreational facility and decided not to build the facility."
-unsuccessful,Unsuccessful,"The planning process is complete, but did not yield a contracting process. For example, a buyer completed consultations about the construction of a new recreational facility, but decided not to build the facility."
+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/release-schema.json b/schema/release-schema.json
index d686b23cf..02b5818c6 100644
--- a/schema/release-schema.json
+++ b/schema/release-schema.json
@@ -163,24 +163,8 @@
           "description": "Details of the budget that will fund the future contract(s)",
           "$ref": "#/definitions/Budget"
         },
-        "documents": {
-          "title": "Documents",
-          "description": "Documents related to the planning process (for example, notices, needs assessments and market studies).",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/Document"
-          }
-        },
-        "milestones": {
-          "title": "Planning milestones",
-          "description": "Milestones associated with the planning process.",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/Milestone"
-          }
-        },
         "finalStatus": {
-          "title": "Planning final status",
+          "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",
@@ -194,14 +178,38 @@
             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": "Planning final status date",
+          "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).",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Document"
+          }
+        },
+        "milestones": {
+          "title": "Planning milestones",
+          "description": "Milestones associated with the planning process.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Milestone"
+          }
         }
       }
     },