prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(dir): 📄 doc GET licenses vm

Browse source
This commit is contained in:
Collin M. Barrett 2021-11-27 13:50:42 -06:00
parent df8eed7fa2
commit c692aa8820
2 changed files with 45 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
services/Directory/FilterLists.Directory.Application/Queries/GetLanguages.cs
View file

@ -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>();
}
}

48
services/Directory/FilterLists.Directory.Application/Queries/GetLicenses.cs
View file

@ -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>();
}
}