fix: Upgrade to the API specification 2.1.1 PXWEB-931 (#498)

likp · web-flow · commit f4b444569bb0 · 2025-12-12T17:48:34.000+01:00
* Changed `CodeList` to `Codelist`

* Updated to latest version of the spec 2.1.1

* Avoid duplicate mapping in SavedQueryApiController

Refactored the code to map the saved query response only once in the SavedQueryApiController. The mapped response is now reused for both extracting the URI and returning the Created() result, improving efficiency and code readability.
diff --git a/PxWeb.UnitTests/Helpers/SelectionUtilTests.cs b/PxWeb.UnitTests/Helpers/SelectionUtilTests.cs
@@ -132,7 +132,7 @@ public void VariablesSelectionFromCodelists_WhenOneCodelist_ReturnsSelectionWith
             Assert.IsNotNull(result);
             Assert.HasCount(1, result.Selection);
             Assert.AreEqual("A", result.Selection[0].VariableCode);
-            Assert.AreEqual("B", result.Selection[0].CodeList);
+            Assert.AreEqual("B", result.Selection[0].Codelist);
 
         }
     }
diff --git a/PxWeb/Code/Api2/DataSelection/SelectionHandler.cs b/PxWeb/Code/Api2/DataSelection/SelectionHandler.cs
@@ -260,18 +260,18 @@ private static bool ApplyCodelist(IPXModelBuilder builder, Variable pxVariable,
         {
             problem = null;
 
-            if (!string.IsNullOrWhiteSpace(variable.CodeList))
+            if (!string.IsNullOrWhiteSpace(variable.Codelist))
             {
                 var notes = PaxiomFixUtil.ExtractNotes(pxVariable);
 
-                if (variable.CodeList.StartsWith("agg_"))
+                if (variable.Codelist.StartsWith("agg_"))
                 {
                     if (!ApplyGrouping(builder, pxVariable, variable, out problem))
                     {
                         return false;
                     }
                 }
-                else if (variable.CodeList.StartsWith("vs_"))
+                else if (variable.Codelist.StartsWith("vs_"))
                 {
                     if (!ApplyValueset(builder, pxVariable, variable, out problem))
                     {
@@ -298,13 +298,13 @@ private static bool ApplyGrouping(IPXModelBuilder builder, Variable pxVariable,
         {
             problem = null;
 
-            if (string.IsNullOrWhiteSpace(variable.CodeList))
+            if (string.IsNullOrWhiteSpace(variable.Codelist))
             {
                 problem = ProblemUtility.NonExistentCodelist();
                 return false;
             }
 
-            GroupingInfo grpInfo = pxVariable.GetGroupingInfoById(variable.CodeList.Replace("agg_", ""));
+            GroupingInfo grpInfo = pxVariable.GetGroupingInfoById(variable.Codelist.Replace("agg_", ""));
 
             if (grpInfo is null)
             {
@@ -332,13 +332,13 @@ private static bool ApplyValueset(IPXModelBuilder builder, Variable pxVariable,
         {
             problem = null;
 
-            if (string.IsNullOrWhiteSpace(variable.CodeList))
+            if (string.IsNullOrWhiteSpace(variable.Codelist))
             {
                 problem = ProblemUtility.NonExistentCodelist();
                 return false;
             }
 
-            ValueSetInfo vsInfo = pxVariable.GetValuesetById(variable.CodeList.Replace("vs_", ""));
+            ValueSetInfo vsInfo = pxVariable.GetValuesetById(variable.Codelist.Replace("vs_", ""));
 
             if (vsInfo is null)
             {
diff --git a/PxWeb/Controllers/Api2/SavedQueryApiController.cs b/PxWeb/Controllers/Api2/SavedQueryApiController.cs
@@ -83,7 +83,9 @@ public override IActionResult CreateSaveQuery([FromBody] SavedQuery? savedQuery)
 
             // 3. Return the SavedQuery with the id set.
             savedQuery.Id = id;
-            return Created(savedQuery.Id, savedQuery);
+            var response = _savedQueryResponseMapper.Map(savedQuery);
+            var uri = response.Links.FirstOrDefault(link => link.Rel == "self")?.Href ?? id;
+            return Created(uri, response);
 
         }
 
diff --git a/PxWeb/Controllers/Api2/TablesApiController.cs b/PxWeb/Controllers/Api2/TablesApiController.cs
@@ -304,7 +304,7 @@ private VariablesSelection MapDataParameters(Dictionary<string, List<string>>? v
                     variableSelection.ValueCodes = valuecodes[variableCode];
                     if (codelist != null && codelist.ContainsKey(variableCode))
                     {
-                        variableSelection.CodeList = codelist[variableCode];
+                        variableSelection.Codelist = codelist[variableCode];
                     }
                     selections.Selection.Add(variableSelection);
                 }
diff --git a/PxWeb/Helper/Api2/SelectionUtil.cs b/PxWeb/Helper/Api2/SelectionUtil.cs
@@ -74,7 +74,7 @@ public static VariablesSelection CreateVariablesSelectionFromCodelists(Dictionar
             {
                 var selection = new VariableSelection();
                 selection.VariableCode = key;
-                selection.CodeList = codelist[key];
+                selection.Codelist = codelist[key];
                 selections.Selection.Add(selection);
             }
 
@@ -157,7 +157,7 @@ public static VariablesSelection Copy(VariablesSelection selection)
             foreach (var variableSelection in selection.Selection)
             {
                 var newVariableSelection = new VariableSelection();
-                newVariableSelection.CodeList = variableSelection.CodeList;
+                newVariableSelection.Codelist = variableSelection.Codelist;
                 newVariableSelection.VariableCode = variableSelection.VariableCode;
                 newVariableSelection.ValueCodes = new List<string>(variableSelection.ValueCodes);
                 copy.Selection.Add(newVariableSelection);
diff --git a/PxWeb/Helper/Api2/VariablesSelectionExtensions.cs b/PxWeb/Helper/Api2/VariablesSelectionExtensions.cs
@@ -11,7 +11,7 @@ public static void AddStubVariable(this VariablesSelection selections, Variable
             var selection = new VariableSelection();
             selection.ValueCodes = new List<string>();
             selection.VariableCode = variable.Code;
-            selection.CodeList = GetCodeList(variable);
+            selection.Codelist = GetCodeList(variable);
             selection.ValueCodes.AddRange(valuesFunction(variable, numberOfValues));
             selections.Selection.Add(selection);
             selections.Placement?.Stub.Add(variable.Code);
@@ -22,7 +22,7 @@ public static void AddHeadingVariable(this VariablesSelection selections, Variab
             var selection = new VariableSelection();
             selection.ValueCodes = new List<string>();
             selection.VariableCode = variable.Code;
-            selection.CodeList = GetCodeList(variable);
+            selection.Codelist = GetCodeList(variable);
             selection.ValueCodes.AddRange(valuesFunction(variable, numberOfValues));
             selections.Selection.Add(selection);
             selections.Placement?.Heading.Add(variable.Code);
@@ -33,7 +33,7 @@ public static void AddVariableToHeading(this VariablesSelection selections, Vari
             var selection = new VariableSelection();
             selection.ValueCodes = new List<string>();
             selection.VariableCode = variable.Code;
-            selection.CodeList = GetCodeList(variable);
+            selection.Codelist = GetCodeList(variable);
             selection.ValueCodes.AddRange(valuesFunction(variable, 1));
             selections.Selection.Add(selection);
             selections.Placement?.Heading.Add(variable.Code);
@@ -44,7 +44,7 @@ public static void EliminateVariable(this VariablesSelection selections, Variabl
             var selection = new VariableSelection();
             selection.ValueCodes = new List<string>();
             selection.VariableCode = variable.Code;
-            selection.CodeList = GetCodeList(variable);
+            selection.Codelist = GetCodeList(variable);
             selections.Selection.Add(selection);
 
         }
diff --git a/PxWeb/Models/Api2/DatasetSubclass.cs b/PxWeb/Models/Api2/DatasetSubclass.cs
@@ -482,11 +482,11 @@ public static void AddCodelist(DimensionValue dimensionValue, List<CodelistInfor
             {
                 dimensionValue.Extension = new ExtensionDimension();
             }
-            if (dimensionValue.Extension.CodeLists == null)
+            if (dimensionValue.Extension.Codelists == null)
             {
-                dimensionValue.Extension.CodeLists = new List<CodelistInformation>();
+                dimensionValue.Extension.Codelists = new List<CodelistInformation>();
             }
-            dimensionValue.Extension.CodeLists.AddRange(codeLists);
+            dimensionValue.Extension.Codelists.AddRange(codeLists);
         }
 
         public static void AddMeasuringType(DimensionValue dimensionValue, string valueCode, MeasuringType measuringType)
diff --git a/PxWeb/PxWeb.csproj b/PxWeb/PxWeb.csproj
@@ -49,7 +49,7 @@
     <PackageReference Include="PCAxis.Menu.ConfigDatamodelMenu" Version="1.0.10" />
     <PackageReference Include="PCAxis.Serializers" Version="1.9.3" />
     <PackageReference Include="PcAxis.Sql" Version="1.5.2" />
-    <PackageReference Include="PxWeb.Api2.Server" Version="2.0.0" />
+    <PackageReference Include="PxWeb.Api2.Server" Version="2.1.1" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
     <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.6" />
     <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="9.0.6" />
diff --git a/PxWebApi_Mvc.Tests/ExpectedJson/MetadataById_tab003_js2.json b/PxWebApi_Mvc.Tests/ExpectedJson/MetadataById_tab003_js2.json
@@ -57,7 +57,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": []
+        "codelists": []
       }
     },
     "WASTE_CAT": {
@@ -139,7 +139,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": []
+        "codelists": []
       }
     },
     "ContentsCode": {
@@ -167,7 +167,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": [],
+        "codelists": [],
         "measuringType": {
           "WasteHazard": "Flow",
           "WasteNonHazard": "Average"
@@ -205,7 +205,7 @@
       "extension": {
         "elimination": false,
         "show": "code",
-        "codeLists": []
+        "codelists": []
       }
     }
   },
diff --git a/PxWebApi_Mvc.Tests/ExpectedJson/MetadataById_tab004_js2.json b/PxWebApi_Mvc.Tests/ExpectedJson/MetadataById_tab004_js2.json
@@ -71,7 +71,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": []
+        "codelists": []
       }
     },
     "GREENHOUSEGAS": {
@@ -112,7 +112,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": []
+        "codelists": []
       }
     },
     "ContentsCode": {
@@ -134,7 +134,7 @@
       "extension": {
         "elimination": false,
         "show": "value",
-        "codeLists": [],
+        "codelists": [],
         "measuringType": {
           "Emission": "Stock"
         },
@@ -213,7 +213,7 @@
       "extension": {
         "elimination": false,
         "show": "code",
-        "codeLists": []
+        "codelists": []
       }
     }
   },

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public void VariablesSelectionFromCodelists_WhenOneCodelist_ReturnsSelectionWith`
`132`	`132`	`Assert.IsNotNull(result);`
`133`	`133`	`Assert.HasCount(1, result.Selection);`
`134`	`134`	`Assert.AreEqual("A", result.Selection[0].VariableCode);`
`135`		`- Assert.AreEqual("B", result.Selection[0].CodeList);`
	`135`	`+ Assert.AreEqual("B", result.Selection[0].Codelist);`
`136`	`136`
`137`	`137`	`}`
`138`	`138`	`}`
Original file line number	Diff line number	Diff line change
`@@ -260,18 +260,18 @@ private static bool ApplyCodelist(IPXModelBuilder builder, Variable pxVariable,`
`260`	`260`	`{`
`261`	`261`	`problem = null;`
`262`	`262`
`263`		`- if (!string.IsNullOrWhiteSpace(variable.CodeList))`
	`263`	`+ if (!string.IsNullOrWhiteSpace(variable.Codelist))`
`264`	`264`	`{`
`265`	`265`	`var notes = PaxiomFixUtil.ExtractNotes(pxVariable);`
`266`	`266`
`267`		`- if (variable.CodeList.StartsWith("agg_"))`
	`267`	`+ if (variable.Codelist.StartsWith("agg_"))`
`268`	`268`	`{`
`269`	`269`	`if (!ApplyGrouping(builder, pxVariable, variable, out problem))`
`270`	`270`	`{`
`271`	`271`	`return false;`
`272`	`272`	`}`
`273`	`273`	`}`
`274`		`- else if (variable.CodeList.StartsWith("vs_"))`
	`274`	`+ else if (variable.Codelist.StartsWith("vs_"))`
`275`	`275`	`{`
`276`	`276`	`if (!ApplyValueset(builder, pxVariable, variable, out problem))`
`277`	`277`	`{`
`@@ -298,13 +298,13 @@ private static bool ApplyGrouping(IPXModelBuilder builder, Variable pxVariable,`
`298`	`298`	`{`
`299`	`299`	`problem = null;`
`300`	`300`
`301`		`- if (string.IsNullOrWhiteSpace(variable.CodeList))`
	`301`	`+ if (string.IsNullOrWhiteSpace(variable.Codelist))`
`302`	`302`	`{`
`303`	`303`	`problem = ProblemUtility.NonExistentCodelist();`
`304`	`304`	`return false;`
`305`	`305`	`}`
`306`	`306`
`307`		`- GroupingInfo grpInfo = pxVariable.GetGroupingInfoById(variable.CodeList.Replace("agg_", ""));`
	`307`	`+ GroupingInfo grpInfo = pxVariable.GetGroupingInfoById(variable.Codelist.Replace("agg_", ""));`
`308`	`308`
`309`	`309`	`if (grpInfo is null)`
`310`	`310`	`{`
`@@ -332,13 +332,13 @@ private static bool ApplyValueset(IPXModelBuilder builder, Variable pxVariable,`
`332`	`332`	`{`
`333`	`333`	`problem = null;`
`334`	`334`
`335`		`- if (string.IsNullOrWhiteSpace(variable.CodeList))`
	`335`	`+ if (string.IsNullOrWhiteSpace(variable.Codelist))`
`336`	`336`	`{`
`337`	`337`	`problem = ProblemUtility.NonExistentCodelist();`
`338`	`338`	`return false;`
`339`	`339`	`}`
`340`	`340`
`341`		`- ValueSetInfo vsInfo = pxVariable.GetValuesetById(variable.CodeList.Replace("vs_", ""));`
	`341`	`+ ValueSetInfo vsInfo = pxVariable.GetValuesetById(variable.Codelist.Replace("vs_", ""));`
`342`	`342`
`343`	`343`	`if (vsInfo is null)`
`344`	`344`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,9 @@ public override IActionResult CreateSaveQuery([FromBody] SavedQuery? savedQuery)`
`83`	`83`
`84`	`84`	`// 3. Return the SavedQuery with the id set.`
`85`	`85`	`savedQuery.Id = id;`
`86`		`- return Created(savedQuery.Id, savedQuery);`
	`86`	`+ var response = _savedQueryResponseMapper.Map(savedQuery);`
	`87`	`+ var uri = response.Links.FirstOrDefault(link => link.Rel == "self")?.Href ?? id;`
	`88`	`+ return Created(uri, response);`
`87`	`89`
`88`	`90`	`}`
`89`	`91`
Original file line number	Diff line number	Diff line change
`@@ -304,7 +304,7 @@ private VariablesSelection MapDataParameters(Dictionary<string, List<string>>? v`
`304`	`304`	`variableSelection.ValueCodes = valuecodes[variableCode];`
`305`	`305`	`if (codelist != null && codelist.ContainsKey(variableCode))`
`306`	`306`	`{`
`307`		`- variableSelection.CodeList = codelist[variableCode];`
	`307`	`+ variableSelection.Codelist = codelist[variableCode];`
`308`	`308`	`}`
`309`	`309`	`selections.Selection.Add(variableSelection);`
`310`	`310`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public static VariablesSelection CreateVariablesSelectionFromCodelists(Dictionar`
`74`	`74`	`{`
`75`	`75`	`var selection = new VariableSelection();`
`76`	`76`	`selection.VariableCode = key;`
`77`		`- selection.CodeList = codelist[key];`
	`77`	`+ selection.Codelist = codelist[key];`
`78`	`78`	`selections.Selection.Add(selection);`
`79`	`79`	`}`
`80`	`80`
`@@ -157,7 +157,7 @@ public static VariablesSelection Copy(VariablesSelection selection)`
`157`	`157`	`foreach (var variableSelection in selection.Selection)`
`158`	`158`	`{`
`159`	`159`	`var newVariableSelection = new VariableSelection();`
`160`		`- newVariableSelection.CodeList = variableSelection.CodeList;`
	`160`	`+ newVariableSelection.Codelist = variableSelection.Codelist;`
`161`	`161`	`newVariableSelection.VariableCode = variableSelection.VariableCode;`
`162`	`162`	`newVariableSelection.ValueCodes = new List<string>(variableSelection.ValueCodes);`
`163`	`163`	`copy.Selection.Add(newVariableSelection);`
Original file line number	Diff line number	Diff line change
`@@ -482,11 +482,11 @@ public static void AddCodelist(DimensionValue dimensionValue, List<CodelistInfor`
`482`	`482`	`{`
`483`	`483`	`dimensionValue.Extension = new ExtensionDimension();`
`484`	`484`	`}`
`485`		`- if (dimensionValue.Extension.CodeLists == null)`
	`485`	`+ if (dimensionValue.Extension.Codelists == null)`
`486`	`486`	`{`
`487`		`- dimensionValue.Extension.CodeLists = new List<CodelistInformation>();`
	`487`	`+ dimensionValue.Extension.Codelists = new List<CodelistInformation>();`
`488`	`488`	`}`
`489`		`- dimensionValue.Extension.CodeLists.AddRange(codeLists);`
	`489`	`+ dimensionValue.Extension.Codelists.AddRange(codeLists);`
`490`	`490`	`}`
`491`	`491`
`492`	`492`	`public static void AddMeasuringType(DimensionValue dimensionValue, string valueCode, MeasuringType measuringType)`