Several changes to the sentences (coscine/issues#1082)

src/Controllers/MetadataController.cs

@@ -16,7 +16,7 @@ using VDS.RDF.Writing;
 namespace Coscine.Api.Metadata.Controllers
 {
     /// <summary>
-    /// This controller represents the actions which can be taken with a Metadata object.
+    /// This controller represents the actions which can be performed with a Metadata storage.
     /// </summary>
     [Authorize]
     public class MetadataController : Controller
@@ -37,7 +37,7 @@ namespace Coscine.Api.Metadata.Controllers
         }
 
         /// <summary>
-        /// This method returns profiles.
+        /// This method returns all application profiles.
         /// </summary>
         /// <returns>profiles</returns>
         [HttpGet("[controller]/profiles/")]
@@ -49,10 +49,10 @@ namespace Coscine.Api.Metadata.Controllers
         }
 
         /// <summary>
-        /// This method returns profiles with a profileUrl.
+        /// This method returns the application profile for the given profileUrl.
         /// </summary>
-        /// <param name="profile">profile</param>
-        /// <returns>StatusCode 200</returns>
+        /// <param name="profile">Url of the application profile</param>
+        /// <returns>Json with the application profile</returns>
         [HttpGet("[controller]/profiles/{profile}")]
         public IActionResult GetProfile(string profile)
         {
@@ -71,11 +71,11 @@ namespace Coscine.Api.Metadata.Controllers
         }
 
         /// <summary>
-        /// returns the application profile with the fixed values.
+        /// Returns the application profile with the fixed values for the given resource.
         /// </summary>
-        /// <param name="profile">profile</param>
-        /// <param name="resourceId">resourceId</param>
-        /// <returns>StatusCode 403 Success</returns>
+        /// <param name="profile">Url of the application profile</param>
+        /// <param name="resourceId">Id of the resource</param>
+        /// <returns>JSON with the application profile or StatusCode 403</returns>
         [HttpGet("[controller]/profiles/{profile}/{resourceId}")]
         public IActionResult GetApplicationProfileComplete(string profile, string resourceId)
         {
@@ -109,7 +109,7 @@ namespace Coscine.Api.Metadata.Controllers
         }
 
         /// <summary>
-        /// This method returns vocabularies.
+        /// This method returns a list of all vocabularies.
         /// </summary>
         /// <throws>Exception for the code that has not been implemented</throws>
         [HttpGet("[controller]/vocabularies/")]
@@ -119,10 +119,10 @@ namespace Coscine.Api.Metadata.Controllers
         }
 
         /// <summary>
-        /// This method returns vocabularies.
+        /// This method returns a specific vocabulary.
         /// </summary>
-        /// <param name="path"></param>
-        /// <returns>vocabularies as Json</returns>
+        /// <param name="path">Url of the vocabulary</param>
+        /// <returns>JSON with the requested vocabulary</returns>
         [HttpGet("[controller]/vocabularies/{path}")]
         public IActionResult GetVocabulary(string path)
         {
@@ -162,9 +162,9 @@ namespace Coscine.Api.Metadata.Controllers
         /// <summary>
         /// This method returns instances.
         /// </summary>
-        /// <param name="projectId">projectId</param>
+        /// <param name="projectId">Id of the project</param>
         /// <param name="className">class name</param>
-        /// <returns>instances as Json, or throw an Exception as not been authorized</returns>
+        /// <returns>instances as Json, or throw an Exception if the user has not beed authorized</returns>
         [HttpGet("[controller]/instances/{projectId}/{className}")]
         public IActionResult GetClassInstances(Guid projectId, string className)
         {