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

---
 .../Queries/GetMaintainers.cs                 | 29 ++++++++++++++++
 .../Queries/GetSoftware.cs                    | 34 +++++++++++++++++++
 .../Queries/GetSyntaxes.cs                    | 29 ++++++++++++++++
 .../Queries/GetTags.cs                        | 19 +++++++++++
 4 files changed, 111 insertions(+)

diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetMaintainers.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetMaintainers.cs
index 220745417..4d10d5f42 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetMaintainers.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetMaintainers.cs
@@ -46,11 +46,40 @@ public MaintainerVmProfile()
 
     public record MaintainerVm
     {
+        /// <summary>
+        /// The identifier.
+        /// </summary>
+        /// <example>7</example>
         public long Id { get; init; }
+
+        /// <summary>
+        /// The unique name.
+        /// </summary>
+        /// <example>The EasyList Authors</example>
         public string Name { get; init; } = default!;
+
+        /// <summary>
+        /// The URL of the home page.
+        /// </summary>
+        /// <example>https://easylist.to/</example>
         public Uri? Url { get; init; }
+
+        /// <summary>
+        /// The email address.
+        /// </summary>
+        /// <example>null</example>
         public string? EmailAddress { get; init; }
+
+        /// <summary>
+        /// The Twitter handle.
+        /// </summary>
+        /// <example>null</example>
         public string? TwitterHandle { get; init; }
+
+        /// <summary>
+        /// The identifiers of the FilterLists maintained by this Maintainer.
+        /// </summary>
+        /// <example>[ 11, 13, 301 ]</example>
         public IEnumerable<long> FilterListIds { get; init; } = new HashSet<long>();
     }
 }
diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetSoftware.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetSoftware.cs
index 3b65cbcbd..6da472d61 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetSoftware.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetSoftware.cs
@@ -45,12 +45,46 @@ public SoftwareVmProfile()
 
     public record SoftwareVm
     {
+        /// <summary>
+        /// The identifier.
+        /// </summary>
+        /// <example>2</example>
         public long Id { get; init; }
+
+        /// <summary>
+        /// The unique name.
+        /// </summary>
+        /// <example>Adblock Plus</example>
         public string Name { get; init; } = default!;
+
+        /// <summary>
+        /// The description.
+        /// </summary>
+        /// <example>Adblock Plus is a free extension that allows you to customize your web experience. You can block annoying ads, disable tracking and lots more. It’s available for all major desktop browsers and for your mobile devices.</example>
         public string? Description { get; init; }
+
+        /// <summary>
+        /// The URL of the home page.
+        /// </summary>
+        /// <example>https://adblockplus.org/</example>
         public Uri? HomeUrl { get; init; }
+
+        /// <summary>
+        /// The URL of the Software download.
+        /// </summary>
+        /// <example>https://adblockplus.org/</example>
         public Uri? DownloadUrl { get; init; }
+
+        /// <summary>
+        /// If the Software supports the abp: URL scheme to click-to-subscribe to a FilterList.
+        /// </summary>
+        /// <example>true</example>
         public bool SupportsAbpUrlScheme { get; init; }
+
+        /// <summary>
+        /// The identifiers of the Syntaxes that this Software supports.
+        /// </summary>
+        /// <example>[ 3, 28, 38, 48 ]</example>
         public IEnumerable<long> SyntaxIds { get; init; } = new HashSet<long>();
     }
 }
diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetSyntaxes.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetSyntaxes.cs
index b44a5bcc8..6341ffb9d 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetSyntaxes.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetSyntaxes.cs
@@ -49,11 +49,40 @@ public SyntaxVmProfile()
 
     public record SyntaxVm
     {
+        /// <summary>
+        /// The identifier.
+        /// </summary>
+        /// <example>3</example>
         public long Id { get; init; }
+
+        /// <summary>
+        /// The unique name.
+        /// </summary>
+        /// <example>Adblock Plus</example>
         public string Name { get; init; } = default!;
+
+        /// <summary>
+        /// The description.
+        /// </summary>
+        /// <example>null</example>
         public string? Description { get; init; }
+
+        /// <summary>
+        /// The URL of the home page.
+        /// </summary>
+        /// <example>https://adblockplus.org/filters</example>
         public Uri? Url { get; init; }
+
+        /// <summary>
+        /// The identifiers of the FilterLists implementing this Syntax.
+        /// </summary>
+        /// <example>[ 2, 6, 11 ]</example>
         public IEnumerable<long> FilterListIds { get; init; } = new HashSet<long>();
+
+        /// <summary>
+        /// The identifiers of the Software that supports this Syntax.
+        /// </summary>
+        /// <example>[ 1, 2, 3 ]</example>
         public IEnumerable<long> SoftwareIds { get; init; } = new HashSet<long>();
     }
 }
diff --git a/services/Directory/FilterLists.Directory.Application/Queries/GetTags.cs b/services/Directory/FilterLists.Directory.Application/Queries/GetTags.cs
index a63f84de1..89444c690 100644
--- a/services/Directory/FilterLists.Directory.Application/Queries/GetTags.cs
+++ b/services/Directory/FilterLists.Directory.Application/Queries/GetTags.cs
@@ -46,9 +46,28 @@ public TagVmProfile()
 
     public record TagVm
     {
+        /// <summary>
+        /// The identifier.
+        /// </summary>
+        /// <example>2</example>
         public long Id { get; init; }
+
+        /// <summary>
+        /// The unique name.
+        /// </summary>
+        /// <example>ads</example>
         public string Name { get; init; } = default!;
+
+        /// <summary>
+        /// The description.
+        /// </summary>
+        /// <example>Blocks advertisements</example>
         public string? Description { get; init; }
+
+        /// <summary>
+        /// The identifiers of the FilterLists to which this Tag is applied.
+        /// </summary>
+        /// <example>[ 1, 3, 6 ]</example>
         public IEnumerable<long> FilterListIds { get; init; } = new HashSet<long>();
     }
 }