Skip to content

Commit

Permalink
Documentation updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
FacilityApiBot committed Jul 4, 2024
1 parent b066e5f commit a4d03c8
Show file tree
Hide file tree
Showing 51 changed files with 620 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ConformanceApiHttpHandler.TryHandleFibonacciAsync method

```csharp
public Task<HttpResponseMessage?> TryHandleFibonacciAsync(HttpRequestMessage httpRequest,
CancellationToken cancellationToken = default)
```

## See Also

* class [ConformanceApiHttpHandler](../ConformanceApiHttpHandler.md)
* namespace [Facility.ConformanceApi.Http](../../Facility.ConformanceApi.md)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ConformanceApiHttpMapping.FibonacciMapping field

```csharp
public static readonly HttpMethodMapping<FibonacciRequestDto, FibonacciResponseDto>
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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# HttpClientConformanceApi.FibonacciAsync method

```csharp
public Task<ServiceResult<IAsyncEnumerable<ServiceResult<FibonacciResponseDto>>>> 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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -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)(…) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ConformanceApiService.FibonacciAsync method

```csharp
public Task<ServiceResult<IAsyncEnumerable<ServiceResult<FibonacciResponseDto>>>> 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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
2 changes: 2 additions & 0 deletions docs/Facility.ConformanceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
3 changes: 2 additions & 1 deletion docs/Facility.ConformanceApi/DelegatingConformanceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DelegatingConformanceApi.FibonacciAsync method

```csharp
public virtual Task<ServiceResult<IAsyncEnumerable<ServiceResult<FibonacciResponseDto>>>>
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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
29 changes: 29 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciRequestDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# FibonacciRequestDto class

Request for Fibonacci.

```csharp
public sealed class FibonacciRequestDto : ServiceDto<FibonacciRequestDto>
```

## 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)
<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
12 changes: 12 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciRequestDto/Count.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FibonacciRequestDto constructor

Creates an instance.

```csharp
public FibonacciRequestDto()
```

## See Also

* class [FibonacciRequestDto](../FibonacciRequestDto.md)
* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
14 changes: 14 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciRequestDto/IsEquivalentTo.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
14 changes: 14 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciRequestDto/JsonSerializer.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
14 changes: 14 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciRequestDto/Validate.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
29 changes: 29 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# FibonacciResponseDto class

Response for Fibonacci.

```csharp
public sealed class FibonacciResponseDto : ServiceDto<FibonacciResponseDto>
```

## 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)
<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FibonacciResponseDto constructor

Creates an instance.

```csharp
public FibonacciResponseDto()
```

## See Also

* class [FibonacciResponseDto](../FibonacciResponseDto.md)
* namespace [Facility.ConformanceApi](../../Facility.ConformanceApi.md)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
14 changes: 14 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciResponseDto/Validate.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
12 changes: 12 additions & 0 deletions docs/Facility.ConformanceApi/FibonacciResponseDto/Value.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
1 change: 1 addition & 0 deletions docs/Facility.ConformanceApi/IConformanceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
15 changes: 15 additions & 0 deletions docs/Facility.ConformanceApi/IConformanceApi/FibonacciAsync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# IConformanceApi.FibonacciAsync method

```csharp
public Task<ServiceResult<IAsyncEnumerable<ServiceResult<FibonacciResponseDto>>>> 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)

<!-- DO NOT EDIT: generated by xmldocmd for Facility.ConformanceApi.dll -->
1 change: 1 addition & 0 deletions docs/Facility.Core.Http/HttpClientService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&lt;TRequest,TResponse&gt;](HttpClientService/TrySendEventRequestAsync.md)(…) | Sends an HTTP request for an event and processes the response. |
| [TrySendRequestAsync&lt;TRequest,TResponse&gt;](HttpClientService/TrySendRequestAsync.md)(…) | Sends an HTTP request and processes the response. |

## See Also
Expand Down
Loading

0 comments on commit a4d03c8

Please sign in to comment.