docs(dir): 📄♻ lint endpoint summaries

This commit is contained in:
Collin M. Barrett 2021-11-27 13:15:49 -06:00
parent 2fafdea983
commit f8f7aea66f
8 changed files with 15 additions and 15 deletions

View file

@ -17,7 +17,7 @@ public ChangesController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the changes.
/// ALPHA: Gets the changes to the FilterLists database pending approval.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The changes.</returns>
@ -29,7 +29,7 @@ public Task<IActionResult> Get(CancellationToken cancellationToken)
}
/// <summary>
/// Gets the change.
/// ALPHA: Gets the change to the FilterLists database.
/// </summary>
/// <param name="id">The identifier of the change.</param>
/// <param name="cancellationToken">The cancellation token.</param>

View file

@ -15,10 +15,10 @@ public LanguagesController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the languages targeted by FilterLists.
/// Gets the languages targeted by the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The languages targeted by FilterLists.</returns>
/// <returns>The languages targeted by the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetLanguages.LanguageVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)

View file

@ -15,10 +15,10 @@ public LicensesController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the licenses applied to FilterLists.
/// Gets the licenses applied to the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The licenses applied to FilterLists.</returns>
/// <returns>The licenses applied to the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetLicenses.LicenseVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)

View file

@ -31,7 +31,7 @@ public Task<IActionResult> Get(CancellationToken cancellationToken)
#if DEBUG
/// <summary>
/// Creates the FilterList.
/// ALPHA: Creates the FilterList pending moderator approval.
/// </summary>
/// <param name="command">The command.</param>
/// <param name="cancellationToken">The cancellation token.</param>

View file

@ -15,10 +15,10 @@ public MaintainersController(IMemoryCache cache, IMediator mediator) : base(cach
}
/// <summary>
/// Gets the maintainers of FilterLists.
/// Gets the maintainers of the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The maintainers of FilterLists.</returns>
/// <returns>The maintainers of the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetMaintainers.MaintainerVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)

View file

@ -15,10 +15,10 @@ public SoftwareController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the software that subscribes to FilterLists.
/// Gets the software that subscribes to the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The software that subscribes to FilterLists.</returns>
/// <returns>The software that subscribes to the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetSoftware.SoftwareVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)

View file

@ -15,10 +15,10 @@ public SyntaxesController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the syntaxes of FilterLists.
/// Gets the syntaxes of the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The syntaxes of FilterLists.</returns>
/// <returns>The syntaxes of the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetSyntaxes.SyntaxVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)

View file

@ -15,10 +15,10 @@ public TagsController(IMemoryCache cache, IMediator mediator) : base(cache)
}
/// <summary>
/// Gets the tags of FilterLists.
/// Gets the tags of the FilterLists.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The tags of FilterLists.</returns>
/// <returns>The tags of the FilterLists.</returns>
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<GetTags.TagVm>), StatusCodes.Status200OK)]
public Task<IActionResult> Get(CancellationToken cancellationToken)