From c692aa8820a5469cd57a8619215cecd0f37cbcce Mon Sep 17 00:00:00 2001
From: "Collin M. Barrett" <collinbarrett@users.noreply.github.com>
Date: Sat, 27 Nov 2021 13:50:42 -0600
Subject: [PATCH] =?UTF-8?q?docs(dir):=20=F0=9F=93=84=20doc=20GET=20license?=
 =?UTF-8?q?s=20vm?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../Queries/GetLanguages.cs                   |  8 ++--
 .../Queries/GetLicenses.cs                    | 48 ++++++++++++++++---
 2 files changed, 45 insertions(+), 11 deletions(-)

diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetLanguages.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetLanguages.cs
index 3cf7fd037..c2ebc5430 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetLanguages.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetLanguages.cs
@@ -50,24 +50,24 @@ public record LanguageVm
         /// The identifier.
         /// </summary>
         /// <example>37</example>
-        public long Id { get; init; }
+        public long Id { get; private init; }
 
         /// <summary>
         /// The ISO 639-1 code.
         /// </summary>
         /// <example>en</example>
-        public string Iso6391 { get; init; } = default!;
+        public string Iso6391 { get; private init; } = default!;
 
         /// <summary>
         /// The ISO name.
         /// </summary>
         /// <example>English</example>
-        public string Name { get; init; } = default!;
+        public string Name { get; private init; } = default!;
 
         /// <summary>
         /// The identifiers of the FilterLists targeted by this Language.
         /// </summary>
         /// <example>[ 114, 141 ]</example>
-        public IEnumerable<long> FilterListIds { get; init; } = new HashSet<long>();
+        public IEnumerable<long> FilterListIds { get; private init; } = new HashSet<long>();
     }
 }
diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetLicenses.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetLicenses.cs
index 9357bd83f..f03e9de12 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetLicenses.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetLicenses.cs
@@ -44,12 +44,46 @@ public LicenseVmProfile()
 
     public record LicenseVm
     {
-        public long Id { get; init; }
-        public string Name { get; init; } = default!;
-        public Uri? Url { get; init; }
-        public bool PermitsModification { get; init; }
-        public bool PermitsDistribution { get; init; }
-        public bool PermitsCommercialUse { get; init; }
-        public IEnumerable<long> FilterListIds { get; init; } = new HashSet<long>();
+        /// <summary>
+        ///     The identifier.
+        /// </summary>
+        /// <example>5</example>
+        public long Id { get; private init; }
+
+        /// <summary>
+        ///     The name.
+        /// </summary>
+        /// <example>All Rights Reserved</example>
+        public string Name { get; private init; } = default!;
+
+        /// <summary>
+        ///     The URL of the home page.
+        /// </summary>
+        /// <example>https://en.wikipedia.org/wiki/All_rights_reserved</example>
+        public Uri? Url { get; private init; }
+
+        /// <summary>
+        ///     If the License permits modification.
+        /// </summary>
+        /// <example>false</example>
+        public bool PermitsModification { get; private init; }
+
+        /// <summary>
+        ///     If the License permits distribution.
+        /// </summary>
+        /// <example>false</example>
+        public bool PermitsDistribution { get; private init; }
+
+        /// <summary>
+        ///     If the License permits commercial use.
+        /// </summary>
+        /// <example>false</example>
+        public bool PermitsCommercialUse { get; private init; }
+
+        /// <summary>
+        ///     The identifiers of the FilterLists released under this License.
+        /// </summary>
+        /// <example>[ 6, 31 ]</example>
+        public IEnumerable<long> FilterListIds { get; private init; } = new HashSet<long>();
     }
 }