Skip to content

Commit

Permalink
Merge pull request #35 from SimCubeLtd/develop
Browse files Browse the repository at this point in the history
Update docs for 7.0.0.1 - update gitignore
  • Loading branch information
prom3theu5 authored Nov 9, 2022
2 parents 56adce7 + 2232bcf commit 2a84f9e
Show file tree
Hide file tree
Showing 34 changed files with 628 additions and 691 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -354,3 +354,7 @@ tools/
.idea/

**/TestResults/

.DS_Store

test-output/
1 change: 0 additions & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
<Company>SimCubeLtd</Company>
<VersionPrefix>7.0.0</VersionPrefix>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/SimCubeLtd/SimCube.Spartan</PackageProjectUrl>
</PropertyGroup>

Expand Down
5 changes: 4 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@
* [RequestType](SimCube.Spartan/Enums/RequestType/README.md)
* [SimCube.Spartan.Extensions](SimCube.Spartan/Extensions/README.md)
* [MediatedRequestExtensions](SimCube.Spartan/Extensions/MediatedRequestExtensions/README.md)
* [MediatedStreamExtensions](SimCube.Spartan/Extensions/MediatedStreamExtensions/README.md)
* [ReflectionExtensions](SimCube.Spartan/Extensions/ReflectionExtensions/README.md)
* [RouteHandlerBuilderExtensions](SimCube.Spartan/Extensions/RouteHandlerBuilderExtensions/README.md)
* [SimCube.Spartan.Interfaces](SimCube.Spartan/Interfaces/README.md)
* [IMediatedRequest](SimCube.Spartan/Interfaces/IMediatedRequest/README.md)
* [IMediatedRequest\<TResult\>](SimCube.Spartan/Interfaces/IMediatedRequest-1/README.md)
* [IMediatedStream\<TResult\>](SimCube.Spartan/Interfaces/IMediatedStream-1/README.md)
* [SimCube.Spartan.Requests](SimCube.Spartan/Requests/README.md)
* [BaseMediatedRequest](SimCube.Spartan/Requests/BaseMediatedRequest/README.md)
* [BaseMediatedRequest\<TResult\>](SimCube.Spartan/Requests/BaseMediatedRequest-1/README.md)
* [BaseMediatedStream\<TResult\>](SimCube.Spartan/Requests/BaseMediatedStream-1/README.md)
* [SimCube.Spartan.Validation](SimCube.Spartan/Validation/README.md)
* [ValidationBehavior\<TRequest, TResponse\>](SimCube.Spartan/Validation/ValidationBehavior-2/README.md)
Expand All @@ -29,6 +31,7 @@

* &ensp; \([Object](https://docs.microsoft.com/en-us/dotnet/api/system)\)<a id="class-hierarchy-System_Object"></a>
* &ensp; [&bull;](#class-hierarchy-System_Object "Object") &ensp; [BaseMediatedRequest](SimCube.Spartan/Requests/BaseMediatedRequest/README.md)<a id="class-hierarchy-SimCube_Spartan_Requests_BaseMediatedRequest"></a>
* &ensp; [&bull;](#class-hierarchy-System_Object "Object") &ensp; [BaseMediatedRequest\<TResult\>](SimCube.Spartan/Requests/BaseMediatedRequest-1/README.md)<a id="class-hierarchy-SimCube_Spartan_Requests_BaseMediatedRequest_1"></a>
* &ensp; [&bull;](#class-hierarchy-System_Object "Object") &ensp; [BaseMediatedStream\<TResult\>](SimCube.Spartan/Requests/BaseMediatedStream-1/README.md)<a id="class-hierarchy-SimCube_Spartan_Requests_BaseMediatedStream_1"></a>
* &ensp; [&bull;](#class-hierarchy-System_Object "Object") &ensp; [ValidationBehavior\<TRequest, TResponse\>](SimCube.Spartan/Validation/ValidationBehavior-2/README.md)<a id="class-hierarchy-SimCube_Spartan_Validation_ValidationBehavior_2"></a>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MediatedEndpointAttribute\(RequestType, String\) Constructor
# MediatedEndpointAttribute\(RequestType, String, Boolean\) Constructor

[Home](../../../../README.md)

Expand All @@ -10,7 +10,7 @@
Initializes a new instance of the [MediatedEndpointAttribute](../README.md) class\.

```csharp
public MediatedEndpointAttribute(SimCube.Spartan.Enums.RequestType method, string route)
public MediatedEndpointAttribute(SimCube.Spartan.Enums.RequestType method, string route, bool isGrouped = false)
```

### Parameters
Expand All @@ -21,4 +21,8 @@ The mediated request method\.

**route** &ensp; System\.String

The route to register the endpoint on\.
The route to register the endpoint on\.

**isGrouped** &ensp; System\.Boolean

Specifies if the endpoint should be mapped on the app, or within a group\.
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# MediatedEndpointAttribute\.IsGrouped Property

[Home](../../../../README.md)

**Containing Type**: [MediatedEndpointAttribute](../README.md)

**Assembly**: SimCube\.Spartan\.dll


Gets a value indicating whether the endpoint is grouped\.

```csharp
public bool IsGrouped { get; }
```

### Property Value

System\.Boolean

Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ public sealed class MediatedEndpointAttribute : Attribute

| Constructor | Summary |
| ----------- | ------- |
| [MediatedEndpointAttribute(RequestType, String)](-ctor/README.md) | Initializes a new instance of the [MediatedEndpointAttribute](./README.md) class\. |
| [MediatedEndpointAttribute(RequestType, String, Boolean)](-ctor/README.md) | Initializes a new instance of the [MediatedEndpointAttribute](./README.md) class\. |

## Properties

| Property | Summary |
| -------- | ------- |
| [IsGrouped](IsGrouped/README.md) | Gets a value indicating whether the endpoint is grouped\. |
| [Method](Method/README.md) | Gets the type of the http request\. |
| [Route](Route/README.md) | Gets the route of the endpoint\. |

Original file line number Diff line number Diff line change
@@ -1,16 +1,78 @@
# MediatedRequestExtensions\.MediatedDelete\<TRequest\>\(WebApplication, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method
# MediatedRequestExtensions\.MediatedDelete Method

[Home](../../../../README.md)

**Containing Type**: [MediatedRequestExtensions](../README.md)

**Assembly**: SimCube\.Spartan\.dll

## Overloads

| Method | Summary |
| ------ | ------- |
| [MediatedDelete\<TRequest, TResult\>(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?)](#1238068732) | Map Mediated Delete requests to the specified controller action\. |
| [MediatedDelete\<TRequest\>(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?)](#2165280052) | Map Mediated Delete requests to the specified controller action\. |

<a id="1238068732"></a>

## MediatedDelete\<TRequest, TResult\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\)


Map Mediated Delete requests to the specified controller action\.

```csharp
public static IEndpointRouteBuilder MediatedDelete<TRequest, TResult>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest<TResult>
```

### Type Parameters

**TRequest**

The type of the request to map with its parameters\.

**TResult**

The optional result type\.

### Parameters

**app** &ensp; IEndpointRouteBuilder

The web application instance\.

**route** &ensp; System\.String

the route to map the request on\.

**configureEndpoint** &ensp; Action\<RouteHandlerBuilder\>?

The optional route handler configuration action for endpoint extension\.

**endpointFilters** &ensp; IReadOnlyCollection\<IEndpointFilter\>?

The optional Endpoint filters to chain to the request pipeline\.

**namedCachePolicy** &ensp; System\.String?

The optional named Output Cache Policy to use\.

**namedRateLimitPolicy** &ensp; System\.String?

The optional named Rate Limit Policy to use\.

### Returns

IEndpointRouteBuilder

A type of **IResult**\.<a id="2165280052"></a>

## MediatedDelete\<TRequest\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\)


Map Mediated Delete requests to the specified controller action\.

```csharp
public static WebApplication MediatedDelete<TRequest>(this WebApplication app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest
public static IEndpointRouteBuilder MediatedDelete<TRequest>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest<IResult>
```

### Type Parameters
Expand All @@ -21,7 +83,7 @@ The type of the request to map with its parameters\.

### Parameters

**app** &ensp; WebApplication
**app** &ensp; IEndpointRouteBuilder

The web application instance\.

Expand All @@ -47,6 +109,6 @@ The optional named Rate Limit Policy to use\.

### Returns

WebApplication
IEndpointRouteBuilder

A type of **IResult**\.
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# MediatedStreamExtensions\.MediatedDeleteStream\<TRequest, TResult\>\(WebApplication, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method
# MediatedRequestExtensions\.MediatedDeleteStream\<TRequest, TResult\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method

[Home](../../../../README.md)

**Containing Type**: [MediatedStreamExtensions](../README.md)
**Containing Type**: [MediatedRequestExtensions](../README.md)

**Assembly**: SimCube\.Spartan\.dll


Map Mediated Delete streams to the specified controller action\.

```csharp
public static WebApplication MediatedDeleteStream<TRequest, TResult>(this WebApplication app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedStream<TResult>
public static IEndpointRouteBuilder MediatedDeleteStream<TRequest, TResult>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedStream<TResult>
```

### Type Parameters
Expand All @@ -25,7 +25,7 @@ The type of the result\.

### Parameters

**app** &ensp; WebApplication
**app** &ensp; IEndpointRouteBuilder

The web application instance\.

Expand All @@ -51,6 +51,6 @@ The optional named Rate Limit Policy to use\.

### Returns

WebApplication
IEndpointRouteBuilder

A type of **IResult**\.
Original file line number Diff line number Diff line change
@@ -1,16 +1,78 @@
# MediatedRequestExtensions\.MediatedGet\<TRequest\>\(WebApplication, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method
# MediatedRequestExtensions\.MediatedGet Method

[Home](../../../../README.md)

**Containing Type**: [MediatedRequestExtensions](../README.md)

**Assembly**: SimCube\.Spartan\.dll

## Overloads

| Method | Summary |
| ------ | ------- |
| [MediatedGet\<TRequest, TResult\>(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?)](#3239312544) | Map Mediated Get requests to the specified controller action\. |
| [MediatedGet\<TRequest\>(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?)](#2423506945) | Map Mediated Get requests to the specified controller action\. |

<a id="3239312544"></a>

## MediatedGet\<TRequest, TResult\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\)


Map Mediated Get requests to the specified controller action\.

```csharp
public static IEndpointRouteBuilder MediatedGet<TRequest, TResult>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest<TResult>
```

### Type Parameters

**TRequest**

The type of the request to map with its parameters\.

**TResult**

The optional result type\.

### Parameters

**app** &ensp; IEndpointRouteBuilder

The web application instance\.

**route** &ensp; System\.String

the route to map the request on\.

**configureEndpoint** &ensp; Action\<RouteHandlerBuilder\>?

The optional route handler configuration action for endpoint extension\.

**endpointFilters** &ensp; IReadOnlyCollection\<IEndpointFilter\>?

The optional Endpoint filters to chain to the request pipeline\.

**namedCachePolicy** &ensp; System\.String?

The optional named Output Cache Policy to use\.

**namedRateLimitPolicy** &ensp; System\.String?

The optional named Rate Limit Policy to use\.

### Returns

IEndpointRouteBuilder

A type of **IResult**\.<a id="2423506945"></a>

## MediatedGet\<TRequest\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\)


Map Mediated Get requests to the specified controller action\.

```csharp
public static WebApplication MediatedGet<TRequest>(this WebApplication app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest
public static IEndpointRouteBuilder MediatedGet<TRequest>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedRequest<IResult>
```

### Type Parameters
Expand All @@ -21,7 +83,7 @@ The type of the request to map with its parameters\.

### Parameters

**app** &ensp; WebApplication
**app** &ensp; IEndpointRouteBuilder

The web application instance\.

Expand All @@ -47,6 +109,6 @@ The optional named Rate Limit Policy to use\.

### Returns

WebApplication
IEndpointRouteBuilder

A type of **IResult**\.
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# MediatedStreamExtensions\.MediatedGetStream\<TRequest, TResult\>\(WebApplication, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method
# MediatedRequestExtensions\.MediatedGetStream\<TRequest, TResult\>\(IEndpointRouteBuilder, String, Action\<RouteHandlerBuilder\>?, IReadOnlyCollection\<IEndpointFilter\>?, String?, String?\) Method

[Home](../../../../README.md)

**Containing Type**: [MediatedStreamExtensions](../README.md)
**Containing Type**: [MediatedRequestExtensions](../README.md)

**Assembly**: SimCube\.Spartan\.dll


Map Mediated Get streams to the specified controller action\.

```csharp
public static WebApplication MediatedGetStream<TRequest, TResult>(this WebApplication app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedStream<TResult>
public static IEndpointRouteBuilder MediatedGetStream<TRequest, TResult>(this IEndpointRouteBuilder app, string route, Action<RouteHandlerBuilder>? configureEndpoint = null, IReadOnlyCollection<IEndpointFilter>? endpointFilters = null, string? namedCachePolicy = null, string? namedRateLimitPolicy = null) where TRequest : SimCube.Spartan.Interfaces.IMediatedStream<TResult>
```

### Type Parameters
Expand All @@ -25,7 +25,7 @@ The type of the result\.

### Parameters

**app** &ensp; WebApplication
**app** &ensp; IEndpointRouteBuilder

The web application instance\.

Expand All @@ -51,6 +51,6 @@ The optional named Rate Limit Policy to use\.

### Returns

WebApplication
IEndpointRouteBuilder

A type of **IResult**\.
Loading

0 comments on commit 2a84f9e

Please sign in to comment.