Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/in-depth/client/advanced/maui-aot.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ When using [Native AOT with .NET MAUI](https://learn.microsoft.com/dotnet/maui/d

1. [Implement compiled models for Entity Framework Core](https://learn.microsoft.com/ef/core/performance/advanced-performance-topics?tabs=with-di%2Cexpression-api-with-constant#compiled-models).
2. [Implement source generation in System.Text.Json](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/source-generation).
3. [Enable the Interpreter for iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/macios/interpreter?view=net-maui-8.0#enable-the-interpreter).
3. [Enable the Interpreter for iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/macios/interpreter?view=net-maui-10.0#enable-the-interpreter).

The following are basic instructions on how to fulfill these requirements. However, you should consult the official documentation (linked above) for each requirement.

Expand All @@ -15,7 +15,7 @@ The following are basic instructions on how to fulfill these requirements. Howe

To enable compiled models in your MAUI project:

1. Move your `DbContext` and models to a separate library that targets `net8.0`.
1. Move your `DbContext` and models to a separate library that targets `net10.0`.
2. Create a dummy project with a project reference to the library. This will act as a startup project for the EF Core Tools we will run later. This can be as simple as a console application.
3. Implement an `IDesignTimeDbContextFactory` for your context. This can be placed in your dummy project. For example:

Expand Down Expand Up @@ -108,7 +108,7 @@ Add the following property to the iOS release configuration in your MAUI app pro

The property group should look something like the following:

<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net8.0-ios|AnyCPU'">
<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net10.0-ios|AnyCPU'">
<OptimizePNGs>true</OptimizePNGs>
<MtouchInterpreter>all</MtouchInterpreter>
</PropertyGroup>
Expand Down
2 changes: 1 addition & 1 deletion docs/in-depth/client/online.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The `HttpClientOptions` allows you to specify the following values:
* `Timeout` - a `TimeSpan` (default: 60 seconds); specifies the `HttpClient.Timeout` value for created clients.
* `UserAgent` - the User-Agent header value for each request. By default, a Datasync service specific value is used.

The HTTP pipeline is an important mechanism by which you can adjust the requests as they flow through the Datasync Community Toolkit. For instance, you might want to use a custom delegating handler for authentication, another for logging, and another for adding an API key to the request. If you are adding a custom [HttpClientHandler](https://learn.microsoft.com/dotnet/api/system.net.http.httpclienthandler?view=net-8.0), then it should be the last element in the `HttpPipeline`. You can specify a pipeline like this:
The HTTP pipeline is an important mechanism by which you can adjust the requests as they flow through the Datasync Community Toolkit. For instance, you might want to use a custom delegating handler for authentication, another for logging, and another for adding an API key to the request. If you are adding a custom [HttpClientHandler](https://learn.microsoft.com/dotnet/api/system.net.http.httpclienthandler?view=net-10.0), then it should be the last element in the `HttpPipeline`. You can specify a pipeline like this:

```csharp
using CommunityToolkit.Datasync.Client.Http;
Expand Down
2 changes: 1 addition & 1 deletion docs/in-depth/server/db/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
MySQL is supported via the Entity Framework Core repository. Add the [`Pomelo.EntityFrameworkCore.Mysql`](https://www.nuget.org/packages/Pomelo.EntityFrameworkCore.MySql) driver to your project.

!!! note
You can probably use the `MySql.EntityFrameworkCore` library as well. However, we only test with the Pomelo driver.
As of the v10.0.0 of the Datasync Library, we no longer test MySQL. It **should** work, but we can not make any guarantees. Open an issue if you find problems.

## Set up

Expand Down
10 changes: 5 additions & 5 deletions docs/in-depth/server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Because the datasync service is designed to provide disconnected access over int

## Supported Platforms

The ASP.NET Core packages support ASP.NET 8.0 or later.
The ASP.NET Core packages support ASP.NET 10.0 or later.

The datasync service support a number of backend database servers, and allows for the custom implementation of repositories. Each entity that is synchronized must meet the following criteria:

Expand Down Expand Up @@ -37,8 +37,8 @@ A datasync server based on the Datasync Community Toolkit supports:

To create a new datasync service:

1. Create an ASP.NET 8.0 (or later) WebAPI project.
2. Add Entity Framework Core.
1. Create an ASP.NET 10.0 (or later) WebAPI project.
2. Add Entity Framework Core 10.0 (or later).
3. Add Datasync Community Toolkit.

For information on creating an ASP.NET Core service with Entity Framework Core, see [the official tutorial](https://learn.microsoft.com/aspnet/core/tutorials/first-web-api).
Expand Down Expand Up @@ -202,7 +202,7 @@ If you want to allow both unauthenticated and authenticated access to a table, d

## Configure logging

Logging is handled through [the normal logging mechanism](https://learn.microsoft.com/aspnet/core/fundamentals/logging/?view=aspnetcore-8.0) for ASP.NET Core. Assign the `ILogger` object to the `Logger` property:
Logging is handled through [the normal logging mechanism](https://learn.microsoft.com/aspnet/core/fundamentals/logging/?view=aspnetcore-10.0) for ASP.NET Core. Assign the `ILogger` object to the `Logger` property:

[Route("tables/[controller]")]
public class ModelController : TableController<Model>
Expand Down Expand Up @@ -255,7 +255,7 @@ The `TableController<T>` base class contains an event handler that is called at

## OpenAPI Support

You can publish the API defined by data sync controllers using [NSwag](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-8.0&tabs=visual-studio), [Swashbuckle](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&tabs=visual-studio), or the [OpenApi support in .NET 9](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview?view=aspnetcore-9.0). In all cases, start by setting up the service as you normally would for the chosen library.
You can publish the API defined by data sync controllers using [NSwag](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-10.0&tabs=visual-studio), [Swashbuckle](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-10.0&tabs=visual-studio), or the [OpenApi support in .NET 10](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview?view=aspnetcore-10.0). In all cases, start by setting up the service as you normally would for the chosen library.

Review the instructions for each library:

Expand Down
6 changes: 3 additions & 3 deletions docs/in-depth/server/openapi/net9.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# .NET 9.x OpenApi support
# .NET 10.x OpenApi support

Follow [the basic instructions for OpenApi integration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/aspnetcore-openapi?view=aspnetcore-9.0&tabs=visual-studio), then modify as follows:
Follow [the basic instructions for OpenApi integration](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/aspnetcore-openapi?view=aspnetcore-10.0&tabs=visual-studio), then modify as follows:

1. Add packages to your project to support NSwag. The following packages are required:

Expand Down Expand Up @@ -28,4 +28,4 @@ Browsing to the `/openapi/v1.json` endpoint of the web service allows you to dow

## Known issues

The .NET 9.x OpenApi support currently does not support dynamic schema generation. This means that the schema generated within the OpenApi document will be incomplete.
The .NET 10.x OpenApi support currently does not support dynamic schema generation. This means that the schema generated within the OpenApi document will be incomplete.
2 changes: 1 addition & 1 deletion docs/in-depth/server/openapi/swashbuckle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Swashbuckle support

Follow the [basic instructions for Swashbuckle integration](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-8.0&tabs=visual-studio), then modify as follows:
Follow the [basic instructions for Swashbuckle integration](https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-10.0&tabs=visual-studio), then modify as follows:

1. Add packages to your project to support Swashbuckle. The following packages are required:

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The [Datasync Community Toolkit][nuget] is a collection of libraries that implem

Currently, the library supports:

* ASP.NET Core 8.x or later.
* .NET clients using .NET 8.x or later.
* ASP.NET Core 10.x or later.
* .NET clients using .NET 10.x or later.

> Ensure you match the version of the Datasync Community Toolkit to the version of .NET you are using.

Expand Down