diff --git a/TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj b/TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj index 0ce1900..2d344f8 100644 --- a/TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj +++ b/TransactionProcessorACL.BusinessLogic/TransactionProcessorACL.BusinessLogic.csproj @@ -6,9 +6,9 @@ - + - + diff --git a/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj b/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj index 7a75c0f..d2c545d 100644 --- a/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj +++ b/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.csproj @@ -4,6 +4,10 @@ net5.0;netstandard2.0 + + D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL.DataTransferObjects\TransactionProcessorACL.DataTransferObjects.xml + + diff --git a/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.xml b/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.xml new file mode 100644 index 0000000..ccbb253 --- /dev/null +++ b/TransactionProcessorACL.DataTransferObjects/TransactionProcessorACL.DataTransferObjects.xml @@ -0,0 +1,201 @@ + + + + TransactionProcessorACL.DataTransferObjects + + + + + + + + + + + Gets or sets the contract identifier. + + + The contract identifier. + + + + + Gets or sets the operator identifier. + + + The operator identifier. + + + + + Gets or sets the transaction count. + + + The transaction count. + + + + + Gets or sets the transaction value. + + + The transaction value. + + + + + Gets or sets the operator totals. + + + The operator totals. + + + + + Gets or sets the transaction count. + + + The transaction count. + + + + + Gets or sets the transaction value. + + + The transaction value. + + + + + + + + + + + Gets or sets the contract identifier. + + + The contract identifier. + + + + + Gets or sets the operator identifier. + + + The operator identifier. + + + + + Gets or sets the customer email address. + + + The customer email address. + + + + + Gets or sets the product identifier. + + + The product identifier. + + + + + + + + + + Gets or sets the application version. + + + The application version. + + + + + Gets or sets the device identifier. + + + The device identifier. + + + + + Gets or sets the transaction date time. + + + The transaction date time. + + + + + Gets or sets the transaction number. + + + The transaction number. + + + + + Gets or sets the additional request meta data. + + + The additional request meta data. + + + + + Gets or sets the response code. + + + The response code. + + + + + Gets or sets the response message. + + + The response message. + + + + + Gets or sets the additional response meta data. + + + The additional response meta data. + + + + + Gets or sets the estate identifier. + + + The estate identifier. + + + + + Gets or sets the merchant identifier. + + + The merchant identifier. + + + + + Gets or sets a value indicating whether [requires application update]. + + + true if [requires application update]; otherwise, false. + + + + diff --git a/TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj b/TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj index a140f4e..3696605 100644 --- a/TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj +++ b/TransactionProcessorACL.IntegrationTests/TransactionProcessorACL.IntegrationTests.csproj @@ -9,20 +9,20 @@ - + - + - + all diff --git a/TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj b/TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj index 6b72850..f2b6ecb 100644 --- a/TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj +++ b/TransactionProcessorACL.Testing/TransactionProcessorACL.Testing.csproj @@ -6,7 +6,7 @@ - + diff --git a/TransactionProcessorACL/Startup.cs b/TransactionProcessorACL/Startup.cs index ecaa4eb..146c59c 100644 --- a/TransactionProcessorACL/Startup.cs +++ b/TransactionProcessorACL/Startup.cs @@ -132,6 +132,16 @@ private void ConfigureMiddlewareServices(IServiceCollection services) // add a custom operation filter which sets default values c.OperationFilter(); c.ExampleFilters(); + + //Locate the XML files being generated by ASP.NET... + var directory = new DirectoryInfo(AppContext.BaseDirectory); + var xmlFiles = directory.GetFiles("*.xml"); + + //... and tell Swagger to use those XML comments. + foreach (FileInfo fileInfo in xmlFiles) + { + c.IncludeXmlComments(fileInfo.FullName); + } }); services.AddSwaggerExamplesFromAssemblyOf(); diff --git a/TransactionProcessorACL/TransactionProcessorACL.csproj b/TransactionProcessorACL/TransactionProcessorACL.csproj index 666c6ec..ba99167 100644 --- a/TransactionProcessorACL/TransactionProcessorACL.csproj +++ b/TransactionProcessorACL/TransactionProcessorACL.csproj @@ -5,6 +5,10 @@ Linux + + D:\Projects\StuartFerguson\TransactionProcessorACL\TransactionProcessorACL\TransactionProcessorACL.xml + + diff --git a/TransactionProcessorACL/TransactionProcessorACL.xml b/TransactionProcessorACL/TransactionProcessorACL.xml new file mode 100644 index 0000000..27215a5 --- /dev/null +++ b/TransactionProcessorACL/TransactionProcessorACL.xml @@ -0,0 +1,317 @@ + + + + TransactionProcessorACL + + + + + Gets the user claims. + + The user. + Type of the custom claim. + The default value. + + No claim [{customClaimType}] found for user id [{userIdClaim.Value} + + + + Determines whether [is client token] [the specified user]. + + The user. + + true if [is client token] [the specified user]; otherwise, false. + + + + + Validates the route parameter. + + + The route parameter. + The user claim. + + + + Determines whether [is user roles valid] [the specified user]. + + The user. + The allowed roles. + + true if [is user roles valid] [the specified user]; otherwise, false. + + + + + + + + + + The transaction count + + + + + The transaction value + + + + + The application version + + + + + The device identifier + + + + + The transaction date time + + + + + The transaction number + + + + + The contract identifier + + + + + The customer email address + + + + + The operator identifier + + + + + The product identifier + + + + + The estate identifier + + + + + The merchant identifier + + + + + The response code + + + + + The response message + + + + + The requires application update + + + + + + + + + + + Gets the examples. + + + + + + + + + + + + Gets the examples. + + + + + + Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter. + + This is only required due to bugs in the . + Once they are fixed and published, this class can be removed. + + + + Applies the filter to the specified operation using the given context. + + The operation to apply the filter to. + The current operation filter context. + + + + Gets a value indicating whether this can read JSON. + + + true if this can read JSON; otherwise, false. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + + The object value. + + + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + + + + + + + The mediator + + + + + The model factory + + + + + Initializes a new instance of the class. + + The mediator. + The model factory. + + + + Performs the transaction. + + The transaction request. + The cancellation token. + + + + + Creates the command from request. + + The logon transaction request message. + + + + + Creates the command from request. + + The sale transaction request message. + + + + + Creates the command from request. + + The reconciliation request message. + + + + + The controller name + + + + + The controller route + + + + + + + + + + Converts from. + + The process logon transaction response. + + + + + Converts from. + + The process sale transaction response. + + + + + Converts from. + + The process reconciliation response. + + + + + + + + + + + Converts from. + + The process logon transaction response. + + + + + Converts from. + + The process sale transaction response. + + + + + Converts from. + + The process reconciliation response. + + + +