From a4d03c87b0bb540344545623b34012ffc0abb761 Mon Sep 17 00:00:00 2001 From: FacilityApiBot Date: Thu, 4 Jul 2024 13:59:05 +0000 Subject: [PATCH] Documentation updated. --- .../CSharpGenerator/GenerateCSharp.md | 3 +- .../ConformanceApiHttpHandler.md | 1 + .../TryHandleFibonacciAsync.md | 13 +++++++++ .../ConformanceApiHttpMapping.md | 1 + .../FibonacciMapping.md | 15 ++++++++++ .../HttpClientConformanceApi.md | 1 + .../FibonacciAsync.md | 15 ++++++++++ .../ConformanceApiService.md | 1 + .../ConformanceApiService/FibonacciAsync.md | 15 ++++++++++ docs/Facility.ConformanceApi.md | 2 ++ .../DelegatingConformanceApi.md | 3 +- .../DelegatingConformanceApi.md | 4 +-- .../FibonacciAsync.md | 15 ++++++++++ .../FibonacciRequestDto.md | 29 +++++++++++++++++++ .../FibonacciRequestDto/Count.md | 12 ++++++++ .../FibonacciRequestDto.md | 14 +++++++++ .../FibonacciRequestDto/IsEquivalentTo.md | 14 +++++++++ .../FibonacciRequestDto/JsonSerializer.md | 14 +++++++++ .../FibonacciRequestDto/Validate.md | 14 +++++++++ .../FibonacciResponseDto.md | 29 +++++++++++++++++++ .../FibonacciResponseDto.md | 14 +++++++++ .../FibonacciResponseDto/IsEquivalentTo.md | 14 +++++++++ .../FibonacciResponseDto/JsonSerializer.md | 14 +++++++++ .../FibonacciResponseDto/Validate.md | 14 +++++++++ .../FibonacciResponseDto/Value.md | 12 ++++++++ .../IConformanceApi.md | 1 + .../IConformanceApi/FibonacciAsync.md | 15 ++++++++++ docs/Facility.Core.Http/HttpClientService.md | 1 + .../TrySendEventRequestAsync.md | 21 ++++++++++++++ docs/Facility.Core.Http/ServiceHttpHandler.md | 1 + .../TryHandleServiceEventAsync.md | 22 ++++++++++++++ docs/Facility.Core.md | 5 +++- docs/Facility.Core/IServiceEventInfo.md | 26 +++++++++++++++++ .../IServiceEventInfo/InvokeAsync.md | 17 +++++++++++ docs/Facility.Core/IServiceEventInfo/Name.md | 14 +++++++++ .../IServiceEventInfo/ServiceName.md | 14 +++++++++ docs/Facility.Core/ServiceDelegate.md | 28 ++++++++++++++++++ .../ServiceDelegate/FromDelegator.md | 15 ++++++++++ .../ServiceDelegate/InvokeEventAsync.md | 18 ++++++++++++ .../ServiceDelegate/InvokeMethodAsync.md | 18 ++++++++++++ .../ServiceDelegate/ServiceDelegate.md | 14 +++++++++ docs/Facility.Core/ServiceDelegates.md | 22 ++++++++++++++ .../Facility.Core/ServiceDelegates/Forward.md | 15 ++++++++++ .../ServiceDelegates/NotImplemented.md | 15 ++++++++++ .../ServiceDelegates/Validate.md | 15 ++++++++++ docs/Facility.Core/ServiceDelegators.md | 22 -------------- .../ServiceDelegators/Forward.md | 15 ---------- .../ServiceDelegators/NotImplemented.md | 15 ---------- .../ServiceDelegators/Validate.md | 15 ---------- docs/Facility.Core/ServiceEventInfo.md | 20 +++++++++++++ docs/Facility.Core/ServiceEventInfo/Create.md | 25 ++++++++++++++++ 51 files changed, 620 insertions(+), 72 deletions(-) create mode 100644 docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler/TryHandleFibonacciAsync.md create mode 100644 docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping/FibonacciMapping.md create mode 100644 docs/Facility.ConformanceApi.Http/HttpClientConformanceApi/FibonacciAsync.md create mode 100644 docs/Facility.ConformanceApi.Testing/ConformanceApiService/FibonacciAsync.md create mode 100644 docs/Facility.ConformanceApi/DelegatingConformanceApi/FibonacciAsync.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto/Count.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto/FibonacciRequestDto.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto/IsEquivalentTo.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto/JsonSerializer.md create mode 100644 docs/Facility.ConformanceApi/FibonacciRequestDto/Validate.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto/FibonacciResponseDto.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto/IsEquivalentTo.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto/JsonSerializer.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto/Validate.md create mode 100644 docs/Facility.ConformanceApi/FibonacciResponseDto/Value.md create mode 100644 docs/Facility.ConformanceApi/IConformanceApi/FibonacciAsync.md create mode 100644 docs/Facility.Core.Http/HttpClientService/TrySendEventRequestAsync.md create mode 100644 docs/Facility.Core.Http/ServiceHttpHandler/TryHandleServiceEventAsync.md create mode 100644 docs/Facility.Core/IServiceEventInfo.md create mode 100644 docs/Facility.Core/IServiceEventInfo/InvokeAsync.md create mode 100644 docs/Facility.Core/IServiceEventInfo/Name.md create mode 100644 docs/Facility.Core/IServiceEventInfo/ServiceName.md create mode 100644 docs/Facility.Core/ServiceDelegate.md create mode 100644 docs/Facility.Core/ServiceDelegate/FromDelegator.md create mode 100644 docs/Facility.Core/ServiceDelegate/InvokeEventAsync.md create mode 100644 docs/Facility.Core/ServiceDelegate/InvokeMethodAsync.md create mode 100644 docs/Facility.Core/ServiceDelegate/ServiceDelegate.md create mode 100644 docs/Facility.Core/ServiceDelegates.md create mode 100644 docs/Facility.Core/ServiceDelegates/Forward.md create mode 100644 docs/Facility.Core/ServiceDelegates/NotImplemented.md create mode 100644 docs/Facility.Core/ServiceDelegates/Validate.md delete mode 100644 docs/Facility.Core/ServiceDelegators.md delete mode 100644 docs/Facility.Core/ServiceDelegators/Forward.md delete mode 100644 docs/Facility.Core/ServiceDelegators/NotImplemented.md delete mode 100644 docs/Facility.Core/ServiceDelegators/Validate.md create mode 100644 docs/Facility.Core/ServiceEventInfo.md create mode 100644 docs/Facility.Core/ServiceEventInfo/Create.md diff --git a/docs/Facility.CodeGen.CSharp/CSharpGenerator/GenerateCSharp.md b/docs/Facility.CodeGen.CSharp/CSharpGenerator/GenerateCSharp.md index bdfb0325..53bacbc4 100644 --- a/docs/Facility.CodeGen.CSharp/CSharpGenerator/GenerateCSharp.md +++ b/docs/Facility.CodeGen.CSharp/CSharpGenerator/GenerateCSharp.md @@ -3,11 +3,12 @@ Generates C#. ```csharp -public static int GenerateCSharp(CSharpGeneratorSettings settings) +public static int GenerateCSharp(ServiceParser parser, CSharpGeneratorSettings settings) ``` | parameter | description | | --- | --- | +| parser | The parser. | | settings | The settings. | ## Return Value diff --git a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler.md b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler.md index a3e9566d..2a09e61c 100644 --- a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler.md +++ b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler.md @@ -16,6 +16,7 @@ public sealed class ConformanceApiHttpHandler : ServiceHttpHandler | [TryHandleCheckQueryAsync](ConformanceApiHttpHandler/TryHandleCheckQueryAsync.md)(…) | | | [TryHandleCreateWidgetAsync](ConformanceApiHttpHandler/TryHandleCreateWidgetAsync.md)(…) | Creates a new widget. | | [TryHandleDeleteWidgetAsync](ConformanceApiHttpHandler/TryHandleDeleteWidgetAsync.md)(…) | Deletes the specified widget. | +| [TryHandleFibonacciAsync](ConformanceApiHttpHandler/TryHandleFibonacciAsync.md)(…) | | | [TryHandleGetApiInfoAsync](ConformanceApiHttpHandler/TryHandleGetApiInfoAsync.md)(…) | Gets API information. | | [TryHandleGetWidgetAsync](ConformanceApiHttpHandler/TryHandleGetWidgetAsync.md)(…) | Gets the specified widget. | | [TryHandleGetWidgetBatchAsync](ConformanceApiHttpHandler/TryHandleGetWidgetBatchAsync.md)(…) | Gets the specified widgets. | diff --git a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler/TryHandleFibonacciAsync.md b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler/TryHandleFibonacciAsync.md new file mode 100644 index 00000000..b7d8db9c --- /dev/null +++ b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpHandler/TryHandleFibonacciAsync.md @@ -0,0 +1,13 @@ +# ConformanceApiHttpHandler.TryHandleFibonacciAsync method + +```csharp +public Task TryHandleFibonacciAsync(HttpRequestMessage httpRequest, + CancellationToken cancellationToken = default) +``` + +## See Also + +* class [ConformanceApiHttpHandler](../ConformanceApiHttpHandler.md) +* namespace [Facility.ConformanceApi.Http](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping.md b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping.md index 861751ea..709f81fd 100644 --- a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping.md +++ b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping.md @@ -15,6 +15,7 @@ public static class ConformanceApiHttpMapping | static readonly [CheckQueryMapping](ConformanceApiHttpMapping/CheckQueryMapping.md) | | | static readonly [CreateWidgetMapping](ConformanceApiHttpMapping/CreateWidgetMapping.md) | Creates a new widget. | | static readonly [DeleteWidgetMapping](ConformanceApiHttpMapping/DeleteWidgetMapping.md) | Deletes the specified widget. | +| static readonly [FibonacciMapping](ConformanceApiHttpMapping/FibonacciMapping.md) | | | static readonly [GetApiInfoMapping](ConformanceApiHttpMapping/GetApiInfoMapping.md) | Gets API information. | | static readonly [GetWidgetBatchMapping](ConformanceApiHttpMapping/GetWidgetBatchMapping.md) | Gets the specified widgets. | | static readonly [GetWidgetMapping](ConformanceApiHttpMapping/GetWidgetMapping.md) | Gets the specified widget. | diff --git a/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping/FibonacciMapping.md b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping/FibonacciMapping.md new file mode 100644 index 00000000..b0f2e6da --- /dev/null +++ b/docs/Facility.ConformanceApi.Http/ConformanceApiHttpMapping/FibonacciMapping.md @@ -0,0 +1,15 @@ +# ConformanceApiHttpMapping.FibonacciMapping field + +```csharp +public static readonly HttpMethodMapping + FibonacciMapping; +``` + +## See Also + +* class [FibonacciRequestDto](../../Facility.ConformanceApi/FibonacciRequestDto.md) +* class [FibonacciResponseDto](../../Facility.ConformanceApi/FibonacciResponseDto.md) +* class [ConformanceApiHttpMapping](../ConformanceApiHttpMapping.md) +* namespace [Facility.ConformanceApi.Http](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi.md b/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi.md index 2b5bcc51..d22a82d9 100644 --- a/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi.md +++ b/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi.md @@ -16,6 +16,7 @@ public sealed class HttpClientConformanceApi : HttpClientService, IConformanceAp | [CheckQueryAsync](HttpClientConformanceApi/CheckQueryAsync.md)(…) | | | [CreateWidgetAsync](HttpClientConformanceApi/CreateWidgetAsync.md)(…) | Creates a new widget. | | [DeleteWidgetAsync](HttpClientConformanceApi/DeleteWidgetAsync.md)(…) | Deletes the specified widget. | +| [FibonacciAsync](HttpClientConformanceApi/FibonacciAsync.md)(…) | | | [GetApiInfoAsync](HttpClientConformanceApi/GetApiInfoAsync.md)(…) | Gets API information. | | [GetWidgetAsync](HttpClientConformanceApi/GetWidgetAsync.md)(…) | Gets the specified widget. | | [GetWidgetBatchAsync](HttpClientConformanceApi/GetWidgetBatchAsync.md)(…) | Gets the specified widgets. | diff --git a/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi/FibonacciAsync.md b/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi/FibonacciAsync.md new file mode 100644 index 00000000..10e38abf --- /dev/null +++ b/docs/Facility.ConformanceApi.Http/HttpClientConformanceApi/FibonacciAsync.md @@ -0,0 +1,15 @@ +# HttpClientConformanceApi.FibonacciAsync method + +```csharp +public Task>>> FibonacciAsync( + FibonacciRequestDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [FibonacciResponseDto](../../Facility.ConformanceApi/FibonacciResponseDto.md) +* class [FibonacciRequestDto](../../Facility.ConformanceApi/FibonacciRequestDto.md) +* class [HttpClientConformanceApi](../HttpClientConformanceApi.md) +* namespace [Facility.ConformanceApi.Http](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi.Testing/ConformanceApiService.md b/docs/Facility.ConformanceApi.Testing/ConformanceApiService.md index e84611f3..2c4ca018 100644 --- a/docs/Facility.ConformanceApi.Testing/ConformanceApiService.md +++ b/docs/Facility.ConformanceApi.Testing/ConformanceApiService.md @@ -16,6 +16,7 @@ public sealed class ConformanceApiService : IConformanceApi | [CheckQueryAsync](ConformanceApiService/CheckQueryAsync.md)(…) | | | [CreateWidgetAsync](ConformanceApiService/CreateWidgetAsync.md)(…) | | | [DeleteWidgetAsync](ConformanceApiService/DeleteWidgetAsync.md)(…) | | +| [FibonacciAsync](ConformanceApiService/FibonacciAsync.md)(…) | | | [GetApiInfoAsync](ConformanceApiService/GetApiInfoAsync.md)(…) | | | [GetWidgetAsync](ConformanceApiService/GetWidgetAsync.md)(…) | | | [GetWidgetBatchAsync](ConformanceApiService/GetWidgetBatchAsync.md)(…) | | diff --git a/docs/Facility.ConformanceApi.Testing/ConformanceApiService/FibonacciAsync.md b/docs/Facility.ConformanceApi.Testing/ConformanceApiService/FibonacciAsync.md new file mode 100644 index 00000000..f2b0349c --- /dev/null +++ b/docs/Facility.ConformanceApi.Testing/ConformanceApiService/FibonacciAsync.md @@ -0,0 +1,15 @@ +# ConformanceApiService.FibonacciAsync method + +```csharp +public Task>>> FibonacciAsync( + FibonacciRequestDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [FibonacciResponseDto](../../Facility.ConformanceApi/FibonacciResponseDto.md) +* class [FibonacciRequestDto](../../Facility.ConformanceApi/FibonacciRequestDto.md) +* class [ConformanceApiService](../ConformanceApiService.md) +* namespace [Facility.ConformanceApi.Testing](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi.md b/docs/Facility.ConformanceApi.md index 2b398936..b68c569d 100644 --- a/docs/Facility.ConformanceApi.md +++ b/docs/Facility.ConformanceApi.md @@ -23,6 +23,8 @@ | class [DelegatingConformanceApi](./Facility.ConformanceApi/DelegatingConformanceApi.md) | A delegating implementation of ConformanceApi. | | class [DeleteWidgetRequestDto](./Facility.ConformanceApi/DeleteWidgetRequestDto.md) | Request for DeleteWidget. | | class [DeleteWidgetResponseDto](./Facility.ConformanceApi/DeleteWidgetResponseDto.md) | Response for DeleteWidget. | +| class [FibonacciRequestDto](./Facility.ConformanceApi/FibonacciRequestDto.md) | Request for Fibonacci. | +| class [FibonacciResponseDto](./Facility.ConformanceApi/FibonacciResponseDto.md) | Response for Fibonacci. | | class [GetApiInfoRequestDto](./Facility.ConformanceApi/GetApiInfoRequestDto.md) | Request for GetApiInfo. | | class [GetApiInfoResponseDto](./Facility.ConformanceApi/GetApiInfoResponseDto.md) | Response for GetApiInfo. | | class [GetWidgetBatchRequestDto](./Facility.ConformanceApi/GetWidgetBatchRequestDto.md) | Request for GetWidgetBatch. | diff --git a/docs/Facility.ConformanceApi/DelegatingConformanceApi.md b/docs/Facility.ConformanceApi/DelegatingConformanceApi.md index ff5a7776..8701d8ef 100644 --- a/docs/Facility.ConformanceApi/DelegatingConformanceApi.md +++ b/docs/Facility.ConformanceApi/DelegatingConformanceApi.md @@ -10,12 +10,13 @@ public class DelegatingConformanceApi : IConformanceApi | name | description | | --- | --- | -| [DelegatingConformanceApi](DelegatingConformanceApi/DelegatingConformanceApi.md)(…) | Creates an instance with the specified delegator. | +| [DelegatingConformanceApi](DelegatingConformanceApi/DelegatingConformanceApi.md)(…) | Creates an instance with the specified service delegate. | | virtual [BodyTypesAsync](DelegatingConformanceApi/BodyTypesAsync.md)(…) | | | virtual [CheckPathAsync](DelegatingConformanceApi/CheckPathAsync.md)(…) | | | virtual [CheckQueryAsync](DelegatingConformanceApi/CheckQueryAsync.md)(…) | | | virtual [CreateWidgetAsync](DelegatingConformanceApi/CreateWidgetAsync.md)(…) | Creates a new widget. | | virtual [DeleteWidgetAsync](DelegatingConformanceApi/DeleteWidgetAsync.md)(…) | Deletes the specified widget. | +| virtual [FibonacciAsync](DelegatingConformanceApi/FibonacciAsync.md)(…) | | | virtual [GetApiInfoAsync](DelegatingConformanceApi/GetApiInfoAsync.md)(…) | Gets API information. | | virtual [GetWidgetAsync](DelegatingConformanceApi/GetWidgetAsync.md)(…) | Gets the specified widget. | | virtual [GetWidgetBatchAsync](DelegatingConformanceApi/GetWidgetBatchAsync.md)(…) | Gets the specified widgets. | diff --git a/docs/Facility.ConformanceApi/DelegatingConformanceApi/DelegatingConformanceApi.md b/docs/Facility.ConformanceApi/DelegatingConformanceApi/DelegatingConformanceApi.md index a1300049..1a77d042 100644 --- a/docs/Facility.ConformanceApi/DelegatingConformanceApi/DelegatingConformanceApi.md +++ b/docs/Facility.ConformanceApi/DelegatingConformanceApi/DelegatingConformanceApi.md @@ -1,9 +1,9 @@ # DelegatingConformanceApi constructor -Creates an instance with the specified delegator. +Creates an instance with the specified service delegate. ```csharp -public DelegatingConformanceApi(ServiceDelegator delegator) +public DelegatingConformanceApi(ServiceDelegate serviceDelegate) ``` ## See Also diff --git a/docs/Facility.ConformanceApi/DelegatingConformanceApi/FibonacciAsync.md b/docs/Facility.ConformanceApi/DelegatingConformanceApi/FibonacciAsync.md new file mode 100644 index 00000000..ec777638 --- /dev/null +++ b/docs/Facility.ConformanceApi/DelegatingConformanceApi/FibonacciAsync.md @@ -0,0 +1,15 @@ +# DelegatingConformanceApi.FibonacciAsync method + +```csharp +public virtual Task>>> + FibonacciAsync(FibonacciRequestDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* class [DelegatingConformanceApi](../DelegatingConformanceApi.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto.md b/docs/Facility.ConformanceApi/FibonacciRequestDto.md new file mode 100644 index 00000000..c3a15078 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto.md @@ -0,0 +1,29 @@ +# FibonacciRequestDto class + +Request for Fibonacci. + +```csharp +public sealed class FibonacciRequestDto : ServiceDto +``` + +## Public Members + +| name | description | +| --- | --- | +| [FibonacciRequestDto](FibonacciRequestDto/FibonacciRequestDto.md)() | Creates an instance. | +| [Count](FibonacciRequestDto/Count.md) { get; set; } | | +| override [IsEquivalentTo](FibonacciRequestDto/IsEquivalentTo.md)(…) | Determines if two DTOs are equivalent. | +| override [Validate](FibonacciRequestDto/Validate.md)(…) | Validates the DTO. | + +## Protected Members + +| name | description | +| --- | --- | +| override [JsonSerializer](FibonacciRequestDto/JsonSerializer.md) { get; } | The JSON serializer. | + +## See Also + +* namespace [Facility.ConformanceApi](../Facility.ConformanceApi.md) +* [FibonacciRequestDto.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.ConformanceApi/FibonacciRequestDto.cs) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto/Count.md b/docs/Facility.ConformanceApi/FibonacciRequestDto/Count.md new file mode 100644 index 00000000..88de713e --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto/Count.md @@ -0,0 +1,12 @@ +# FibonacciRequestDto.Count property + +```csharp +public int? Count { get; set; } +``` + +## See Also + +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto/FibonacciRequestDto.md b/docs/Facility.ConformanceApi/FibonacciRequestDto/FibonacciRequestDto.md new file mode 100644 index 00000000..a5732586 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto/FibonacciRequestDto.md @@ -0,0 +1,14 @@ +# FibonacciRequestDto constructor + +Creates an instance. + +```csharp +public FibonacciRequestDto() +``` + +## See Also + +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto/IsEquivalentTo.md b/docs/Facility.ConformanceApi/FibonacciRequestDto/IsEquivalentTo.md new file mode 100644 index 00000000..f741566c --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto/IsEquivalentTo.md @@ -0,0 +1,14 @@ +# FibonacciRequestDto.IsEquivalentTo method + +Determines if two DTOs are equivalent. + +```csharp +public override bool IsEquivalentTo(FibonacciRequestDto? other) +``` + +## See Also + +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto/JsonSerializer.md b/docs/Facility.ConformanceApi/FibonacciRequestDto/JsonSerializer.md new file mode 100644 index 00000000..76cb4e1a --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto/JsonSerializer.md @@ -0,0 +1,14 @@ +# FibonacciRequestDto.JsonSerializer property + +The JSON serializer. + +```csharp +protected override JsonServiceSerializer JsonSerializer { get; } +``` + +## See Also + +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciRequestDto/Validate.md b/docs/Facility.ConformanceApi/FibonacciRequestDto/Validate.md new file mode 100644 index 00000000..97dfdac3 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciRequestDto/Validate.md @@ -0,0 +1,14 @@ +# FibonacciRequestDto.Validate method + +Validates the DTO. + +```csharp +public override bool Validate(out string? errorMessage) +``` + +## See Also + +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto.md b/docs/Facility.ConformanceApi/FibonacciResponseDto.md new file mode 100644 index 00000000..bb16c942 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto.md @@ -0,0 +1,29 @@ +# FibonacciResponseDto class + +Response for Fibonacci. + +```csharp +public sealed class FibonacciResponseDto : ServiceDto +``` + +## Public Members + +| name | description | +| --- | --- | +| [FibonacciResponseDto](FibonacciResponseDto/FibonacciResponseDto.md)() | Creates an instance. | +| [Value](FibonacciResponseDto/Value.md) { get; set; } | | +| override [IsEquivalentTo](FibonacciResponseDto/IsEquivalentTo.md)(…) | Determines if two DTOs are equivalent. | +| override [Validate](FibonacciResponseDto/Validate.md)(…) | Validates the DTO. | + +## Protected Members + +| name | description | +| --- | --- | +| override [JsonSerializer](FibonacciResponseDto/JsonSerializer.md) { get; } | The JSON serializer. | + +## See Also + +* namespace [Facility.ConformanceApi](../Facility.ConformanceApi.md) +* [FibonacciResponseDto.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.ConformanceApi/FibonacciResponseDto.cs) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto/FibonacciResponseDto.md b/docs/Facility.ConformanceApi/FibonacciResponseDto/FibonacciResponseDto.md new file mode 100644 index 00000000..553482c5 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto/FibonacciResponseDto.md @@ -0,0 +1,14 @@ +# FibonacciResponseDto constructor + +Creates an instance. + +```csharp +public FibonacciResponseDto() +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto/IsEquivalentTo.md b/docs/Facility.ConformanceApi/FibonacciResponseDto/IsEquivalentTo.md new file mode 100644 index 00000000..243943bd --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto/IsEquivalentTo.md @@ -0,0 +1,14 @@ +# FibonacciResponseDto.IsEquivalentTo method + +Determines if two DTOs are equivalent. + +```csharp +public override bool IsEquivalentTo(FibonacciResponseDto? other) +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto/JsonSerializer.md b/docs/Facility.ConformanceApi/FibonacciResponseDto/JsonSerializer.md new file mode 100644 index 00000000..6036f283 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto/JsonSerializer.md @@ -0,0 +1,14 @@ +# FibonacciResponseDto.JsonSerializer property + +The JSON serializer. + +```csharp +protected override JsonServiceSerializer JsonSerializer { get; } +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto/Validate.md b/docs/Facility.ConformanceApi/FibonacciResponseDto/Validate.md new file mode 100644 index 00000000..139780a6 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto/Validate.md @@ -0,0 +1,14 @@ +# FibonacciResponseDto.Validate method + +Validates the DTO. + +```csharp +public override bool Validate(out string? errorMessage) +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/FibonacciResponseDto/Value.md b/docs/Facility.ConformanceApi/FibonacciResponseDto/Value.md new file mode 100644 index 00000000..30b24863 --- /dev/null +++ b/docs/Facility.ConformanceApi/FibonacciResponseDto/Value.md @@ -0,0 +1,12 @@ +# FibonacciResponseDto.Value property + +```csharp +public int? Value { get; set; } +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.ConformanceApi/IConformanceApi.md b/docs/Facility.ConformanceApi/IConformanceApi.md index 4adb2bd0..e992de90 100644 --- a/docs/Facility.ConformanceApi/IConformanceApi.md +++ b/docs/Facility.ConformanceApi/IConformanceApi.md @@ -15,6 +15,7 @@ public interface IConformanceApi | [CheckQueryAsync](IConformanceApi/CheckQueryAsync.md)(…) | | | [CreateWidgetAsync](IConformanceApi/CreateWidgetAsync.md)(…) | Creates a new widget. | | [DeleteWidgetAsync](IConformanceApi/DeleteWidgetAsync.md)(…) | Deletes the specified widget. | +| [FibonacciAsync](IConformanceApi/FibonacciAsync.md)(…) | | | [GetApiInfoAsync](IConformanceApi/GetApiInfoAsync.md)(…) | Gets API information. | | [GetWidgetAsync](IConformanceApi/GetWidgetAsync.md)(…) | Gets the specified widget. | | [GetWidgetBatchAsync](IConformanceApi/GetWidgetBatchAsync.md)(…) | Gets the specified widgets. | diff --git a/docs/Facility.ConformanceApi/IConformanceApi/FibonacciAsync.md b/docs/Facility.ConformanceApi/IConformanceApi/FibonacciAsync.md new file mode 100644 index 00000000..c3dcf631 --- /dev/null +++ b/docs/Facility.ConformanceApi/IConformanceApi/FibonacciAsync.md @@ -0,0 +1,15 @@ +# IConformanceApi.FibonacciAsync method + +```csharp +public Task>>> FibonacciAsync( + FibonacciRequestDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [FibonacciResponseDto](../FibonacciResponseDto.md) +* class [FibonacciRequestDto](../FibonacciRequestDto.md) +* interface [IConformanceApi](../IConformanceApi.md) +* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md) + + diff --git a/docs/Facility.Core.Http/HttpClientService.md b/docs/Facility.Core.Http/HttpClientService.md index 2a656cfa..51719251 100644 --- a/docs/Facility.Core.Http/HttpClientService.md +++ b/docs/Facility.Core.Http/HttpClientService.md @@ -19,6 +19,7 @@ public abstract class HttpClientService | virtual [CreateErrorFromHttpResponseAsync](HttpClientService/CreateErrorFromHttpResponseAsync.md)(…) | Called to create an error object from an unhandled HTTP response. | | virtual [RequestReadyAsync](HttpClientService/RequestReadyAsync.md)(…) | Called right before the request is sent, before aspects are applied. | | virtual [ShouldCreateErrorFromException](HttpClientService/ShouldCreateErrorFromException.md)(…) | Called to determine if an error object should be created from an unexpected exception. | +| [TrySendEventRequestAsync<TRequest,TResponse>](HttpClientService/TrySendEventRequestAsync.md)(…) | Sends an HTTP request for an event and processes the response. | | [TrySendRequestAsync<TRequest,TResponse>](HttpClientService/TrySendRequestAsync.md)(…) | Sends an HTTP request and processes the response. | ## See Also diff --git a/docs/Facility.Core.Http/HttpClientService/TrySendEventRequestAsync.md b/docs/Facility.Core.Http/HttpClientService/TrySendEventRequestAsync.md new file mode 100644 index 00000000..badd7b1e --- /dev/null +++ b/docs/Facility.Core.Http/HttpClientService/TrySendEventRequestAsync.md @@ -0,0 +1,21 @@ +# HttpClientService.TrySendEventRequestAsync<TRequest,TResponse> method + +Sends an HTTP request for an event and processes the response. + +```csharp +protected Task>>> + TrySendEventRequestAsync(HttpMethodMapping mapping, + TRequest request, CancellationToken cancellationToken) + where TRequest : ServiceDto, new() + where TResponse : ServiceDto, new() +``` + +## See Also + +* class [ServiceResult<T>](../../Facility.Core/ServiceResult-1.md) +* class [HttpMethodMapping<TRequest,TResponse>](../HttpMethodMapping-2.md) +* class [ServiceDto](../../Facility.Core/ServiceDto.md) +* class [HttpClientService](../HttpClientService.md) +* namespace [Facility.Core.Http](../../Facility.Core.md) + + diff --git a/docs/Facility.Core.Http/ServiceHttpHandler.md b/docs/Facility.Core.Http/ServiceHttpHandler.md index 318f8ce1..ac8ad860 100644 --- a/docs/Facility.Core.Http/ServiceHttpHandler.md +++ b/docs/Facility.Core.Http/ServiceHttpHandler.md @@ -23,6 +23,7 @@ public abstract class ServiceHttpHandler : DelegatingHandler | override [SendAsync](ServiceHttpHandler/SendAsync.md)(…) | Handle or delegate the HTTP request. | | virtual [ShouldCreateErrorFromException](ServiceHttpHandler/ShouldCreateErrorFromException.md)(…) | Called to determine if an error object should be created from an unexpected exception. | | virtual [TryGetCustomHttpStatusCode](ServiceHttpHandler/TryGetCustomHttpStatusCode.md)(…) | Returns the HTTP status code for a custom error code. | +| [TryHandleServiceEventAsync<TRequest,TResponse>](ServiceHttpHandler/TryHandleServiceEventAsync.md)(…) | Attempts to handle a service method. | | [TryHandleServiceMethodAsync<TRequest,TResponse>](ServiceHttpHandler/TryHandleServiceMethodAsync.md)(…) | Attempts to handle a service method. | ## See Also diff --git a/docs/Facility.Core.Http/ServiceHttpHandler/TryHandleServiceEventAsync.md b/docs/Facility.Core.Http/ServiceHttpHandler/TryHandleServiceEventAsync.md new file mode 100644 index 00000000..a5b18dec --- /dev/null +++ b/docs/Facility.Core.Http/ServiceHttpHandler/TryHandleServiceEventAsync.md @@ -0,0 +1,22 @@ +# ServiceHttpHandler.TryHandleServiceEventAsync<TRequest,TResponse> method + +Attempts to handle a service method. + +```csharp +protected Task TryHandleServiceEventAsync( + HttpMethodMapping mapping, HttpRequestMessage httpRequest, + Func>>>> invokeEventAsync, + CancellationToken cancellationToken) + where TRequest : ServiceDto, new() + where TResponse : ServiceDto, new() +``` + +## See Also + +* class [HttpMethodMapping<TRequest,TResponse>](../HttpMethodMapping-2.md) +* class [ServiceResult<T>](../../Facility.Core/ServiceResult-1.md) +* class [ServiceDto](../../Facility.Core/ServiceDto.md) +* class [ServiceHttpHandler](../ServiceHttpHandler.md) +* namespace [Facility.Core.Http](../../Facility.Core.md) + + diff --git a/docs/Facility.Core.md b/docs/Facility.Core.md index 9dd8495f..c9c1849c 100644 --- a/docs/Facility.Core.md +++ b/docs/Facility.Core.md @@ -4,12 +4,14 @@ | public type | description | | --- | --- | +| interface [IServiceEventInfo](./Facility.Core/IServiceEventInfo.md) | Information about a Facility service event. | | interface [IServiceMethodInfo](./Facility.Core/IServiceMethodInfo.md) | Information about a Facility service method. | | abstract class [JsonServiceSerializer](./Facility.Core/JsonServiceSerializer.md) | Serializes and deserializes values to and from JSON. | | class [NewtonsoftJsonServiceSerializer](./Facility.Core/NewtonsoftJsonServiceSerializer.md) | Serializes to and from JSON using JsonSerializer. | | static class [ServiceDataUtility](./Facility.Core/ServiceDataUtility.md) | Helper methods for service data. | +| abstract class [ServiceDelegate](./Facility.Core/ServiceDelegate.md) | Used to delegate a service. | +| static class [ServiceDelegates](./Facility.Core/ServiceDelegates.md) | Common service delegates. | | delegate [ServiceDelegator](./Facility.Core/ServiceDelegator.md) | Called when delegating a service method. | -| static class [ServiceDelegators](./Facility.Core/ServiceDelegators.md) | Common service delegators. | | abstract class [ServiceDto<T>](./Facility.Core/ServiceDto-1.md) | Base class for data objects used by services. | | abstract class [ServiceDto](./Facility.Core/ServiceDto.md) | Base class for data objects used by services. | | abstract class [ServiceEnumJsonConverter<T>](./Facility.Core/ServiceEnumJsonConverter-1.md) | Used to JSON-serialize string-based enumerated types. | @@ -17,6 +19,7 @@ | class [ServiceErrorDto](./Facility.Core/ServiceErrorDto.md) | An error. | | static class [ServiceErrors](./Facility.Core/ServiceErrors.md) | Common service errors. | | static class [ServiceErrorUtility](./Facility.Core/ServiceErrorUtility.md) | Helper methods for service errors. | +| static class [ServiceEventInfo](./Facility.Core/ServiceEventInfo.md) | Helpers for service event information. | | class [ServiceException](./Facility.Core/ServiceException.md) | An exception thrown by a service method. | | abstract class [ServiceJsonConverterBase<T>](./Facility.Core/ServiceJsonConverterBase-1.md) | Base class for simple JSON converters. | | static class [ServiceJsonUtility](./Facility.Core/ServiceJsonUtility.md) | Helper methods for working with Json.NET. | diff --git a/docs/Facility.Core/IServiceEventInfo.md b/docs/Facility.Core/IServiceEventInfo.md new file mode 100644 index 00000000..e188275c --- /dev/null +++ b/docs/Facility.Core/IServiceEventInfo.md @@ -0,0 +1,26 @@ +# IServiceEventInfo interface + +Information about a Facility service event. + +```csharp +public interface IServiceEventInfo +``` + +## Members + +| name | description | +| --- | --- | +| [Name](IServiceEventInfo/Name.md) { get; } | The name of the event. | +| [ServiceName](IServiceEventInfo/ServiceName.md) { get; } | The name of the service. | +| [InvokeAsync](IServiceEventInfo/InvokeAsync.md)(…) | Invokes the method on the specified service instance. | + +## Remarks + +Do not implement this interface. New members on this interface will not be considered a breaking change. + +## See Also + +* namespace [Facility.Core](../Facility.Core.md) +* [IServiceEventInfo.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.Core/IServiceEventInfo.cs) + + diff --git a/docs/Facility.Core/IServiceEventInfo/InvokeAsync.md b/docs/Facility.Core/IServiceEventInfo/InvokeAsync.md new file mode 100644 index 00000000..20ec714e --- /dev/null +++ b/docs/Facility.Core/IServiceEventInfo/InvokeAsync.md @@ -0,0 +1,17 @@ +# IServiceEventInfo.InvokeAsync method + +Invokes the method on the specified service instance. + +```csharp +public Task>>> InvokeAsync(object service, + ServiceDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [ServiceResult<T>](../ServiceResult-1.md) +* class [ServiceDto](../ServiceDto.md) +* interface [IServiceEventInfo](../IServiceEventInfo.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/IServiceEventInfo/Name.md b/docs/Facility.Core/IServiceEventInfo/Name.md new file mode 100644 index 00000000..d3c1e194 --- /dev/null +++ b/docs/Facility.Core/IServiceEventInfo/Name.md @@ -0,0 +1,14 @@ +# IServiceEventInfo.Name property + +The name of the event. + +```csharp +public string Name { get; } +``` + +## See Also + +* interface [IServiceEventInfo](../IServiceEventInfo.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/IServiceEventInfo/ServiceName.md b/docs/Facility.Core/IServiceEventInfo/ServiceName.md new file mode 100644 index 00000000..9d4a8962 --- /dev/null +++ b/docs/Facility.Core/IServiceEventInfo/ServiceName.md @@ -0,0 +1,14 @@ +# IServiceEventInfo.ServiceName property + +The name of the service. + +```csharp +public string ServiceName { get; } +``` + +## See Also + +* interface [IServiceEventInfo](../IServiceEventInfo.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegate.md b/docs/Facility.Core/ServiceDelegate.md new file mode 100644 index 00000000..01044ee8 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegate.md @@ -0,0 +1,28 @@ +# ServiceDelegate class + +Used to delegate a service. + +```csharp +public abstract class ServiceDelegate +``` + +## Public Members + +| name | description | +| --- | --- | +| static [FromDelegator](ServiceDelegate/FromDelegator.md)(…) | Creates a service delegate from a service delegator. | +| virtual [InvokeEventAsync](ServiceDelegate/InvokeEventAsync.md)(…) | Delegates the service event. | +| virtual [InvokeMethodAsync](ServiceDelegate/InvokeMethodAsync.md)(…) | Delegates the service method. | + +## Protected Members + +| name | description | +| --- | --- | +| [ServiceDelegate](ServiceDelegate/ServiceDelegate.md)() | The default constructor. | + +## See Also + +* namespace [Facility.Core](../Facility.Core.md) +* [ServiceDelegate.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.Core/ServiceDelegate.cs) + + diff --git a/docs/Facility.Core/ServiceDelegate/FromDelegator.md b/docs/Facility.Core/ServiceDelegate/FromDelegator.md new file mode 100644 index 00000000..dddc7d40 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegate/FromDelegator.md @@ -0,0 +1,15 @@ +# ServiceDelegate.FromDelegator method + +Creates a service delegate from a service delegator. + +```csharp +public static ServiceDelegate FromDelegator(ServiceDelegator delegator) +``` + +## See Also + +* delegate [ServiceDelegator](../ServiceDelegator.md) +* class [ServiceDelegate](../ServiceDelegate.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegate/InvokeEventAsync.md b/docs/Facility.Core/ServiceDelegate/InvokeEventAsync.md new file mode 100644 index 00000000..0c56c8b6 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegate/InvokeEventAsync.md @@ -0,0 +1,18 @@ +# ServiceDelegate.InvokeEventAsync method + +Delegates the service event. + +```csharp +public virtual Task>>> InvokeEventAsync( + IServiceEventInfo eventInfo, ServiceDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [ServiceResult<T>](../ServiceResult-1.md) +* class [ServiceDto](../ServiceDto.md) +* interface [IServiceEventInfo](../IServiceEventInfo.md) +* class [ServiceDelegate](../ServiceDelegate.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegate/InvokeMethodAsync.md b/docs/Facility.Core/ServiceDelegate/InvokeMethodAsync.md new file mode 100644 index 00000000..daf80263 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegate/InvokeMethodAsync.md @@ -0,0 +1,18 @@ +# ServiceDelegate.InvokeMethodAsync method + +Delegates the service method. + +```csharp +public virtual Task> InvokeMethodAsync(IServiceMethodInfo methodInfo, + ServiceDto request, CancellationToken cancellationToken = default) +``` + +## See Also + +* class [ServiceResult<T>](../ServiceResult-1.md) +* class [ServiceDto](../ServiceDto.md) +* interface [IServiceMethodInfo](../IServiceMethodInfo.md) +* class [ServiceDelegate](../ServiceDelegate.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegate/ServiceDelegate.md b/docs/Facility.Core/ServiceDelegate/ServiceDelegate.md new file mode 100644 index 00000000..4e075c7f --- /dev/null +++ b/docs/Facility.Core/ServiceDelegate/ServiceDelegate.md @@ -0,0 +1,14 @@ +# ServiceDelegate constructor + +The default constructor. + +```csharp +protected ServiceDelegate() +``` + +## See Also + +* class [ServiceDelegate](../ServiceDelegate.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegates.md b/docs/Facility.Core/ServiceDelegates.md new file mode 100644 index 00000000..547f2443 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegates.md @@ -0,0 +1,22 @@ +# ServiceDelegates class + +Common service delegates. + +```csharp +public static class ServiceDelegates +``` + +## Public Members + +| name | description | +| --- | --- | +| static [NotImplemented](ServiceDelegates/NotImplemented.md) { get; } | All methods throw NotImplementedException. | +| static [Forward](ServiceDelegates/Forward.md)(…) | Forwards all methods to the inner service. | +| static [Validate](ServiceDelegates/Validate.md)(…) | Validates requests and responses. | + +## See Also + +* namespace [Facility.Core](../Facility.Core.md) +* [ServiceDelegates.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.Core/ServiceDelegates.cs) + + diff --git a/docs/Facility.Core/ServiceDelegates/Forward.md b/docs/Facility.Core/ServiceDelegates/Forward.md new file mode 100644 index 00000000..0bb7e6eb --- /dev/null +++ b/docs/Facility.Core/ServiceDelegates/Forward.md @@ -0,0 +1,15 @@ +# ServiceDelegates.Forward method + +Forwards all methods to the inner service. + +```csharp +public static ServiceDelegate Forward(object inner) +``` + +## See Also + +* class [ServiceDelegate](../ServiceDelegate.md) +* class [ServiceDelegates](../ServiceDelegates.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegates/NotImplemented.md b/docs/Facility.Core/ServiceDelegates/NotImplemented.md new file mode 100644 index 00000000..890a9298 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegates/NotImplemented.md @@ -0,0 +1,15 @@ +# ServiceDelegates.NotImplemented property + +All methods throw NotImplementedException. + +```csharp +public static ServiceDelegate NotImplemented { get; } +``` + +## See Also + +* class [ServiceDelegate](../ServiceDelegate.md) +* class [ServiceDelegates](../ServiceDelegates.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegates/Validate.md b/docs/Facility.Core/ServiceDelegates/Validate.md new file mode 100644 index 00000000..8f943a68 --- /dev/null +++ b/docs/Facility.Core/ServiceDelegates/Validate.md @@ -0,0 +1,15 @@ +# ServiceDelegates.Validate method + +Validates requests and responses. + +```csharp +public static ServiceDelegate Validate(object inner) +``` + +## See Also + +* class [ServiceDelegate](../ServiceDelegate.md) +* class [ServiceDelegates](../ServiceDelegates.md) +* namespace [Facility.Core](../../Facility.Core.md) + + diff --git a/docs/Facility.Core/ServiceDelegators.md b/docs/Facility.Core/ServiceDelegators.md deleted file mode 100644 index f21e6825..00000000 --- a/docs/Facility.Core/ServiceDelegators.md +++ /dev/null @@ -1,22 +0,0 @@ -# ServiceDelegators class - -Common service delegators. - -```csharp -public static class ServiceDelegators -``` - -## Public Members - -| name | description | -| --- | --- | -| static [NotImplemented](ServiceDelegators/NotImplemented.md) { get; } | All methods throw NotImplementedException. | -| static [Forward](ServiceDelegators/Forward.md)(…) | Forwards all methods to the inner service. | -| static [Validate](ServiceDelegators/Validate.md)(…) | Validates requests and responses. | - -## See Also - -* namespace [Facility.Core](../Facility.Core.md) -* [ServiceDelegators.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.Core/ServiceDelegators.cs) - - diff --git a/docs/Facility.Core/ServiceDelegators/Forward.md b/docs/Facility.Core/ServiceDelegators/Forward.md deleted file mode 100644 index 301e9917..00000000 --- a/docs/Facility.Core/ServiceDelegators/Forward.md +++ /dev/null @@ -1,15 +0,0 @@ -# ServiceDelegators.Forward method - -Forwards all methods to the inner service. - -```csharp -public static ServiceDelegator Forward(object inner) -``` - -## See Also - -* delegate [ServiceDelegator](../ServiceDelegator.md) -* class [ServiceDelegators](../ServiceDelegators.md) -* namespace [Facility.Core](../../Facility.Core.md) - - diff --git a/docs/Facility.Core/ServiceDelegators/NotImplemented.md b/docs/Facility.Core/ServiceDelegators/NotImplemented.md deleted file mode 100644 index ff4a2eea..00000000 --- a/docs/Facility.Core/ServiceDelegators/NotImplemented.md +++ /dev/null @@ -1,15 +0,0 @@ -# ServiceDelegators.NotImplemented property - -All methods throw NotImplementedException. - -```csharp -public static ServiceDelegator NotImplemented { get; } -``` - -## See Also - -* delegate [ServiceDelegator](../ServiceDelegator.md) -* class [ServiceDelegators](../ServiceDelegators.md) -* namespace [Facility.Core](../../Facility.Core.md) - - diff --git a/docs/Facility.Core/ServiceDelegators/Validate.md b/docs/Facility.Core/ServiceDelegators/Validate.md deleted file mode 100644 index 3a9cd99c..00000000 --- a/docs/Facility.Core/ServiceDelegators/Validate.md +++ /dev/null @@ -1,15 +0,0 @@ -# ServiceDelegators.Validate method - -Validates requests and responses. - -```csharp -public static ServiceDelegator Validate(object inner) -``` - -## See Also - -* delegate [ServiceDelegator](../ServiceDelegator.md) -* class [ServiceDelegators](../ServiceDelegators.md) -* namespace [Facility.Core](../../Facility.Core.md) - - diff --git a/docs/Facility.Core/ServiceEventInfo.md b/docs/Facility.Core/ServiceEventInfo.md new file mode 100644 index 00000000..6427726f --- /dev/null +++ b/docs/Facility.Core/ServiceEventInfo.md @@ -0,0 +1,20 @@ +# ServiceEventInfo class + +Helpers for service event information. + +```csharp +public static class ServiceEventInfo +``` + +## Public Members + +| name | description | +| --- | --- | +| static [Create<TApi,TRequestDto,TResponseDto>](ServiceEventInfo/Create.md)(…) | Creates service event information. | + +## See Also + +* namespace [Facility.Core](../Facility.Core.md) +* [ServiceEventInfo.cs](https://github.com/FacilityApi/FacilityCSharp/tree/master/src/Facility.Core/ServiceEventInfo.cs) + + diff --git a/docs/Facility.Core/ServiceEventInfo/Create.md b/docs/Facility.Core/ServiceEventInfo/Create.md new file mode 100644 index 00000000..09173c45 --- /dev/null +++ b/docs/Facility.Core/ServiceEventInfo/Create.md @@ -0,0 +1,25 @@ +# ServiceEventInfo.Create<TApi,TRequestDto,TResponseDto> method + +Creates service event information. + +```csharp +public static IServiceEventInfo Create(string name, + string serviceName, + Func>>>>> getInvokeAsync) + where TRequestDto : ServiceDto + where TResponseDto : ServiceDto +``` + +## Remarks + +For internal use by generated code. + +## See Also + +* interface [IServiceEventInfo](../IServiceEventInfo.md) +* class [ServiceResult<T>](../ServiceResult-1.md) +* class [ServiceDto](../ServiceDto.md) +* class [ServiceEventInfo](../ServiceEventInfo.md) +* namespace [Facility.Core](../../Facility.Core.md) + +