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 changes/change vms

Browse source
This commit is contained in:
Collin M. Barrett 2021-11-27 13:21:00 -06:00
parent f8f7aea66f
commit 2a9552bfd1
3 changed files with 171 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
services/Directory/FilterLists.Directory.Api/Controllers/ChangesController.cs
View file

@ -39,7 +39,7 @@ public Task<IActionResult> Get(CancellationToken cancellationToken)
[ProducesResponseType(StatusCodes.Status404NotFound)]
public Task<IActionResult> GetDetails(long id, CancellationToken cancellationToken)
{
return CacheGetOrCreateAsync(() => _mediator.Send(new GetChange.Query(id), cancellationToken), id);
return CacheGetOrCreateAsync(() => _mediator.Send(new GetChange.Query { Id = id }, cancellationToken), id);
}
}

90
services/Directory/FilterLists.Directory.Application/Queries/GetChange.cs
View file

@ -11,7 +11,14 @@ namespace FilterLists.Directory.Application.Queries;
public static class GetChange
{
public record Query(long Id) : IRequest<ChangeVm?>;
public record Query : IRequest<ChangeVm?>
{
/// <summary>
/// The identifier of the change.
/// </summary>
/// <example>99</example>
public long Id { get; init; }
}
internal class Handler : IRequestHandler<Query, ChangeVm?>
{
@ -43,21 +50,102 @@ public ChangesVmProfile()
public record ChangeVm
{
/// <summary>
/// The identifier of the change.
/// </summary>
/// <example>99</example>
public long Id { get; private init; }
/// <summary>
/// The reason for the change.
/// </summary>
/// <example>Adding EasyList because I did not see it on FilterLists.com yet.</example>
public string? Reason { get; private init; }
/// <summary>
/// The time at which the change was submitted.
/// </summary>
/// <example>2021-11-26T20:42:36.022483Z</example>
public DateTime SubmittedAt { get; private init; }
/// <summary>
/// The time at which the change was approved.
/// </summary>
/// <example>2021-11-28T22:43:34.022533Z</example>
public DateTime? ApprovedAt { get; private init; }
/// <summary>
/// The time at which the change was rejected.
/// </summary>
/// <example>null</example>
public DateTime? RejectedAt { get; private init; }
/// <summary>
/// The reason that the change was rejected.
/// </summary>
/// <example>null</example>
public string? RejectedReason { get; private init; }
/// <summary>
/// The snapshot of the entity before this change.
/// </summary>
/// <example>null</example>
public JsonDocument? Before { get; private init; }
/// <summary>
/// The snapshot of the entity after this change.
/// </summary>
/// <example>{"Name":"EasyList2","ChatUrl":null,"HomeUrl":"https://easylist.to/","ForumUrl":"https://forums.lanik.us/viewforum.php?f=23","OnionUrl":null,"DonateUrl":null,"IssuesUrl":"https://github.com/easylist/easylist/issues","LicenseId":4,"PolicyUrl":null,"ViewUrlIds":[0],"Description":"EasyList is the primary filter list that removes most adverts from international web pages, including unwanted frames, images, and objects. It is the most popular list used by many ad blockers and forms the basis of over a dozen combination and supplementary filter lists.","EmailAddress":"easylist@protonmail.com","SubmissionUrl":null}</example>
public JsonDocument? After { get; private init; }
/// <summary>
/// The type of the entity being changed.
/// </summary>
/// <example>
/// <see cref="FilterLists.Directory.Domain.Aggregates.AggregateType.FilterList" />
/// </example>
public AggregateType AggregateType { get; private init; }
/// <summary>
/// The identifier of the FilterList being changed.
/// </summary>
/// <example>3001</example>
public long? FilterListId { get; private init; }
/// <summary>
/// The identifier of the Language being changed.
/// </summary>
/// <example>null</example>
public long? LanguageId { get; private init; }
/// <summary>
/// The identifier of the License being changed.
/// </summary>
/// <example>null</example>
public long? LicenseId { get; private init; }
/// <summary>
/// The identifier of the Maintainer being changed.
/// </summary>
/// <example>null</example>
public long? MaintainerId { get; private init; }
/// <summary>
/// The identifier of the Software being changed.
/// </summary>
/// <example>null</example>
public long? SoftwareId { get; private init; }
/// <summary>
/// The identifier of the Syntax being changed.
/// </summary>
/// <example>null</example>
public long? SyntaxId { get; private init; }
/// <summary>
/// The identifier of the Tag being changed.
/// </summary>
/// <example>null</example>
public long? TagId { get; private init; }
}
}

81
services/Directory/FilterLists.Directory.Application/Queries/GetChanges.cs
View file

@ -44,21 +44,102 @@ public ChangesVmProfile()
public record ChangeVm
{
/// <summary>
/// The identifier of the change.
/// </summary>
/// <example>99</example>
public long Id { get; private init; }
/// <summary>
/// The reason for the change.
/// </summary>
/// <example>Adding EasyList because I did not see it on FilterLists.com yet.</example>
public string? Reason { get; private init; }
/// <summary>
/// The time at which the change was submitted.
/// </summary>
/// <example>2021-11-26T20:42:36.022483Z</example>
public DateTime SubmittedAt { get; private init; }
/// <summary>
/// The time at which the change was approved.
/// </summary>
/// <example>2021-11-28T22:43:34.022533Z</example>
public DateTime? ApprovedAt { get; private init; }
/// <summary>
/// The time at which the change was rejected.
/// </summary>
/// <example>null</example>
public DateTime? RejectedAt { get; private init; }
/// <summary>
/// The reason that the change was rejected.
/// </summary>
/// <example>null</example>
public string? RejectedReason { get; private init; }
/// <summary>
/// The snapshot of the entity before this change.
/// </summary>
/// <example>null</example>
public JsonDocument? Before { get; private init; }
/// <summary>
/// The snapshot of the entity after this change.
/// </summary>
/// <example>{"Name":"EasyList2","ChatUrl":null,"HomeUrl":"https://easylist.to/","ForumUrl":"https://forums.lanik.us/viewforum.php?f=23","OnionUrl":null,"DonateUrl":null,"IssuesUrl":"https://github.com/easylist/easylist/issues","LicenseId":4,"PolicyUrl":null,"ViewUrlIds":[0],"Description":"EasyList is the primary filter list that removes most adverts from international web pages, including unwanted frames, images, and objects. It is the most popular list used by many ad blockers and forms the basis of over a dozen combination and supplementary filter lists.","EmailAddress":"easylist@protonmail.com","SubmissionUrl":null}</example>
public JsonDocument? After { get; private init; }
/// <summary>
/// The type of the entity being changed.
/// </summary>
/// <example>
/// <see cref="FilterLists.Directory.Domain.Aggregates.AggregateType.FilterList" />
/// </example>
public AggregateType AggregateType { get; private init; }
/// <summary>
/// The identifier of the FilterList being changed.
/// </summary>
/// <example>3001</example>
public long? FilterListId { get; private init; }
/// <summary>
/// The identifier of the Language being changed.
/// </summary>
/// <example>null</example>
public long? LanguageId { get; private init; }
/// <summary>
/// The identifier of the License being changed.
/// </summary>
/// <example>null</example>
public long? LicenseId { get; private init; }
/// <summary>
/// The identifier of the Maintainer being changed.
/// </summary>
/// <example>null</example>
public long? MaintainerId { get; private init; }
/// <summary>
/// The identifier of the Software being changed.
/// </summary>
/// <example>null</example>
public long? SoftwareId { get; private init; }
/// <summary>
/// The identifier of the Syntax being changed.
/// </summary>
/// <example>null</example>
public long? SyntaxId { get; private init; }
/// <summary>
/// The identifier of the Tag being changed.
/// </summary>
/// <example>null</example>
public long? TagId { get; private init; }
}
}