Document the used parameters for the SSB classifications provider (#15)

Co-authored-by: Ronny Birkeli <[email protected]>
Altinn · Oct 19, 2023 · b1bd7a0 · b1bd7a0
1 parent 0f67a8b
commit b1bd7a0
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/Altinn.Codelists/SSB/ClassificationCodelistProvider.cs b/src/Altinn.Codelists/SSB/ClassificationCodelistProvider.cs
@@ -70,6 +70,25 @@ public async Task<AppOptions> GetAppOptionsAsync(string language, Dictionary<str
         AppOptions appOptions = GetAppOptions(classificationCode, parentCode);
         appOptions.Parameters = new Dictionary<string, string>(mergedKeyValuePairs);
 
+        // Parameters used added to Parameters collection in AppOptions for reference and documentation purposes.
+        // Add well known parameters first.
+        appOptions.Parameters.TryAdd("id", _classificationId.ToString());
+        appOptions.Parameters.TryAdd("variant", variant);
+        appOptions.Parameters.TryAdd("date", dateOnly.ToString());
+        appOptions.Parameters.TryAdd("language", language);
+        appOptions.Parameters.TryAdd("level", level);
+        appOptions.Parameters.TryAdd("parentCode", parentCode);
+
+        // Add any other parameters.
+        List<string> knownKeys = new () { "id", "variant", "date", "language", "level", "parentCode" };
+        foreach (var keyValuePair in mergedKeyValuePairs)
+        {
+            if (!knownKeys.Contains(keyValuePair.Key))
+            {
+                appOptions.Parameters.TryAdd(keyValuePair.Key, keyValuePair.Value);
+            }
+        }
+
         return appOptions;
     }
 

diff --git a/test/Altinn.Codelists.Tests/SSB/IndustryGroupingCodelistProviderTests.cs b/test/Altinn.Codelists.Tests/SSB/IndustryGroupingCodelistProviderTests.cs
@@ -32,6 +32,7 @@ public async Task GetAppOptionsAsync_FirstLevelOnly_ShouldReturnListOfCodes()
 
         appOptions.Options.Should().HaveCount(21);
         appOptions.Options.First(x => x.Value == "A").Label.Should().Be("Jordbruk, skogbruk og fiske");
+        appOptions.Parameters.First(x => x.Key == "level").Value.Should().Be("1");
     }
 
     [Fact]
@@ -44,5 +45,6 @@ public async Task GetAppOptionsAsync_DefaultFirstLevel_ShouldReturnListOfCodes()
 
         appOptions.Options.Should().HaveCount(21);
         appOptions.Options.First(x => x.Value == "A").Label.Should().Be("Jordbruk, skogbruk og fiske");
+        appOptions.Parameters.First(x => x.Key == "language").Value.Should().Be("nb");
     }
 }