diff --git a/src/Version/Controllers/VersionController.cs b/src/Version/Controllers/VersionController.cs index e301c1e7b2e20dd007e1ae64961bcae4d955e49a..1b683586fa68f10f5e2906a5929153d2edd89fd1 100644 --- a/src/Version/Controllers/VersionController.cs +++ b/src/Version/Controllers/VersionController.cs @@ -8,17 +8,28 @@ using System.Linq; namespace Coscine.Api.Version.Controllers { + + /// <summary> + /// This controller represents the actions which can be taken with a version object. + /// </summary> public class VersionController : Controller { - private readonly IConfiguration _configuration; - + /// <summary> + /// VersionController specifying the configuration. + /// </summary> + /// <param name="logger"></param> public VersionController(ILogger<VersionController> logger) { _configuration = Program.Configuration; } + + /// <summary> + /// Returns the Versions and Ports + /// </summary> + /// <returns>Versions as Json</returns> [HttpGet("[controller]/versions")] public IActionResult Versions() { @@ -32,6 +43,12 @@ namespace Coscine.Api.Version.Controllers return Json(Versions); } + /// <summary> + /// This method returns the versions and ports + /// </summary> + /// <param name="name">name </param> + /// <returns>versions and ports</returns> + [Route("[controller]")] public JArray GetEntries(string name) { var Infos = new JArray(); diff --git a/src/Version/Program.cs b/src/Version/Program.cs index fd99572731651df448b1ac84e5030477dbc103b7..73ec6d3c7318bec2aca4049cb74ab37904ef2bf5 100644 --- a/src/Version/Program.cs +++ b/src/Version/Program.cs @@ -3,9 +3,15 @@ using Coscine.Configuration; namespace Coscine.Api.Version { + /// <summary> + /// Standard Program class. + /// </summary> class Program : AbstractProgram<ConsulConfiguration> { - + /// <summary> + /// Standard Main method. + /// </summary> + /// <param name="args"></param> static void Main(string[] args) { InitializeWebService<Startup>(); diff --git a/src/Version/Startup.cs b/src/Version/Startup.cs index 446ae55a923f1aaa9addb3f5b6f98603e45d6abc..28aaff95d7bfc2fa536fe7fb080ed4cad7bf3d15 100644 --- a/src/Version/Startup.cs +++ b/src/Version/Startup.cs @@ -2,8 +2,14 @@ namespace Coscine.Api.Version { + /// <summary> + /// Standard Startup class. + /// </summary> public class Startup : AbstractDefaultStartup { + /// <summary> + /// Standard Startup constructor + /// </summary> public Startup() {