Applying review suggestion to documentation

This commit is contained in:
Bruce 2020-05-19 18:13:42 +01:00
parent 0d8253d8e2
commit 24543b04c1

View File

@ -1,4 +1,5 @@
#nullable enable #nullable enable
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations;
@ -32,10 +33,10 @@ namespace Jellyfin.Api.Controllers
} }
/// <summary> /// <summary>
/// Gets a package by name or assembly guid. /// Gets a package by name or assembly GUID.
/// </summary> /// </summary>
/// <param name="name">The name of the package.</param> /// <param name="name">The name of the package.</param>
/// <param name="assemblyGuid">The guid of the associated assembly.</param> /// <param name="assemblyGuid">The GUID of the associated assembly.</param>
/// <returns>A <see cref="PackageInfo"/> containing package information.</returns> /// <returns>A <see cref="PackageInfo"/> containing package information.</returns>
[HttpGet("/{Name}")] [HttpGet("/{Name}")]
[ProducesResponseType(typeof(PackageInfo), StatusCodes.Status200OK)] [ProducesResponseType(typeof(PackageInfo), StatusCodes.Status200OK)]
@ -69,7 +70,7 @@ namespace Jellyfin.Api.Controllers
/// Installs a package. /// Installs a package.
/// </summary> /// </summary>
/// <param name="name">Package name.</param> /// <param name="name">Package name.</param>
/// <param name="assemblyGuid">Guid of the associated assembly.</param> /// <param name="assemblyGuid">GUID of the associated assembly.</param>
/// <param name="version">Optional version. Defaults to latest version.</param> /// <param name="version">Optional version. Defaults to latest version.</param>
/// <response code="200">Package found.</response> /// <response code="200">Package found.</response>
/// <response code="404">Package not found.</response> /// <response code="404">Package not found.</response>