1.1.8

Author: AbelCheng

sample/PSWebApi.OwinSample/PSWebApi.OwinSample.csproj

@@ -40,8 +40,8 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="DataBooster.PSWebApi, Version=1.1.7.0, Culture=neutral, PublicKeyToken=ee1eb06d9feeb8dc, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\DataBooster.PSWebApi.1.1.7-beta\lib\net45\DataBooster.PSWebApi.dll</HintPath>
+    <Reference Include="DataBooster.PSWebApi, Version=1.1.8.0, Culture=neutral, PublicKeyToken=ee1eb06d9feeb8dc, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\DataBooster.PSWebApi.1.1.8\lib\net45\DataBooster.PSWebApi.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="Microsoft.CSharp" />

sample/PSWebApi.OwinSample/Properties/AssemblyInfo.cs

@@ -31,5 +31,5 @@
 //
 // You can specify all the values or you can default the Revision and Build Numbers 
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("1.1.7.0")]
-[assembly: AssemblyFileVersion("1.1.7.0")]
+[assembly: AssemblyVersion("1.1.8.0")]
+[assembly: AssemblyFileVersion("1.1.8.0")]

sample/PSWebApi.OwinSample/packages.config

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="DataBooster.PSWebApi" version="1.1.7-beta" targetFramework="net45" />
+  <package id="DataBooster.PSWebApi" version="1.1.8" targetFramework="net45" />
   <package id="Microsoft.AspNet.Cors" version="5.2.3" targetFramework="net45" />
   <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net45" />
   <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net45" />

src/DataBooster.PSWebApi/PSControllerExtensions.async.cs

@@ -17,13 +17,13 @@ namespace DataBooster.PSWebApi
 	public static partial class PSControllerExtensions
 	{
 		/// <summary>
-		/// Asynchronously invokes the PowerShell script by using the supplied input parameters.
+		/// Asynchronously invokes a PowerShell script by using the supplied input parameters.
 		/// </summary>
 		/// <param name="apiController">The ApiController. This is an extension method to ApiController, when you use instance method syntax to call this method, omit this parameter.</param>
 		/// <param name="scriptPath">The fully qualified location of the PowerShell script to be run.</param>
 		/// <param name="parameters">A set of parameters to the PowerShell script. The parameter names and values are taken from the keys and values of a collection.</param>
-		/// <param name="cancellationToken"></param>
-		/// <returns></returns>
+		/// <param name="cancellationToken">The cancellation token can be used to request that the operation be abandoned before completing the execution. Exceptions will be reported via the returned Task object.</param>
+		/// <returns>A task representing the asynchronous operation.</returns>
 		public async static Task<HttpResponseMessage> InvokePowerShellAsync(this ApiController apiController, string scriptPath, IEnumerable<KeyValuePair<string, object>> parameters, CancellationToken cancellationToken)
 		{
 			PSContentNegotiator contentNegotiator = new PSContentNegotiator(apiController.Request);
@@ -76,6 +76,14 @@ private static Task<IList<PSObject>> InvokeAsync(this PowerShell ps, Cancellatio
 			return task;
 		}
 
+		/// <summary>
+		/// Asynchronously invokes a Windows batch file or executable file by using a set of command-line arguments.
+		/// </summary>
+		/// <param name="apiController">The ApiController. This is an extension method to ApiController, when you use instance method syntax to call this method, omit this parameter.</param>
+		/// <param name="scriptPath">The fully qualified location of an application file (batch file or executable file) to be executed.</param>
+		/// <param name="arguments">Command-line arguments to pass when starting the process.</param>
+		/// <param name="cancellationToken">The cancellation token can be used to request that the operation be abandoned before completing the execution. Exceptions will be reported via the returned Task object.</param>
+		/// <returns>A task representing the asynchronous operation.</returns>
 		public static async Task<HttpResponseMessage> InvokeCmdAsync(this ApiController apiController, string scriptPath, string arguments, CancellationToken cancellationToken)
 		{
 			PSContentNegotiator contentNegotiator = new PSContentNegotiator(apiController.Request);

src/DataBooster.PSWebApi/PSControllerExtensions.cmd.cs

@@ -14,24 +14,53 @@ namespace DataBooster.PSWebApi
 {
 	public static partial class PSControllerExtensions
 	{
+		/// <summary>
+		/// Consolidates all the arguments from uri query string and HTTP POST body (if any), as a single string of Command-line arguments.
+		/// </summary>
+		/// <param name="request">The HTTP request where the uri query string part of arguments will be extracted from. This is an extension method to HttpRequestMessage, when you use instance method syntax to call this method, omit this parameter.</param>
+		/// <param name="argsFromBody">A set of raw arguments from HTTP POST body.</param>
+		/// <param name="funcQuoteArgument">A transform function to apply to each raw argument.</param>
+		/// <returns>A single string of Command-line arguments.</returns>
 		public static string BuildCmdArguments(this HttpRequestMessage request, IEnumerable<string> argsFromBody, Func<string, string> funcQuoteArgument)
 		{
 			CmdArgumentsBuilder argsBuilder = new CmdArgumentsBuilder();
 			return argsBuilder.AddFromQueryString(request).Add(argsFromBody).ToString(funcQuoteArgument);
 		}
 
+		/// <summary>
+		/// Consolidates all the arguments from uri query string and HTTP POST body (if any), as a single string of Command-line arguments.
+		/// </summary>
+		/// <param name="request">The HTTP request where the uri query string part of arguments will be extracted from. This is an extension method to HttpRequestMessage, when you use instance method syntax to call this method, omit this parameter.</param>
+		/// <param name="argsFromBody">A set of raw arguments from HTTP POST body.</param>
+		/// <param name="funcQuoteArgument">A transform function to apply to each raw argument.</param>
+		/// <returns>A single string of Command-line arguments.</returns>
 		public static string BuildCmdArguments(this HttpRequestMessage request, IEnumerable<KeyValuePair<string, object>> argsFromBody, Func<string, string> funcQuoteArgument)
 		{
 			CmdArgumentsBuilder argsBuilder = new CmdArgumentsBuilder();
 			return argsBuilder.AddFromQueryString(request).Add(argsFromBody).ToString(funcQuoteArgument);
 		}
 
+		/// <summary>
+		/// Consolidates all the arguments from uri query string and HTTP POST body (if any), as a single string of Command-line arguments.
+		/// </summary>
+		/// <param name="request">The HTTP request where the uri query string part of arguments will be extracted from. This is an extension method to HttpRequestMessage, when you use instance method syntax to call this method, omit this parameter.</param>
+		/// <param name="argsFromBody">A set of raw arguments from HTTP POST body (JSON).</param>
+		/// <param name="funcQuoteArgument">A transform function to apply to each raw argument.</param>
+		/// <returns>A single string of Command-line arguments.</returns>
 		public static string BuildCmdArguments(this HttpRequestMessage request, JToken argsFromBody, Func<string, string> funcQuoteArgument)
 		{
 			CmdArgumentsBuilder argsBuilder = new CmdArgumentsBuilder();
 			return argsBuilder.AddFromQueryString(request).Add(argsFromBody).ToString(funcQuoteArgument);
 		}
 
+		/// <summary>
+		/// Synchronously invokes a Windows batch file or executable file by using a set of command-line arguments.
+		/// </summary>
+		/// <param name="apiController">The ApiController. This is an extension method to ApiController, when you use instance method syntax to call this method, omit this parameter.</param>
+		/// <param name="scriptPath">The fully qualified location of an application file (batch file or executable file) to be executed.</param>
+		/// <param name="arguments">Command-line arguments to pass when starting the process.</param>
+		/// <param name="timeoutSeconds">The time in seconds to wait for the command to execute before terminating the attempt to execute a command and generating an error.</param>
+		/// <returns>A complete HttpResponseMessage contains the standard output (stdout) if the application runs successfully, Otherwise, the standard error (stderr).</returns>
 		public static HttpResponseMessage InvokeCmd(this ApiController apiController, string scriptPath, string arguments, int timeoutSeconds = Timeout.Infinite)
 		{
 			PSContentNegotiator contentNegotiator = new PSContentNegotiator(apiController.Request);

src/DataBooster.PSWebApi/PSControllerExtensions.cs

@@ -34,7 +34,7 @@ static PSControllerExtensions()
 		}
 
 		/// <summary>
-		/// Gathers input parameters from uri query string and concatenates with HTTP POST body.
+		/// Gathers input parameters from uri query string and concatenates with JSON parameters from HTTP POST body.
 		/// </summary>
 		/// <param name="request">The HTTP request. This is an extension method to HttpRequestMessage, when you use instance method syntax to call this method, omit this parameter.</param>
 		/// <param name="parametersFromBody">The parameters read from body.</param>