From f5c3113d95b1ca88079ec48a5627ba5705ccdd65 Mon Sep 17 00:00:00 2001 From: OpenIddict Bot <32257313+openiddict-bot@users.noreply.github.com> Date: Wed, 13 Jan 2021 05:32:54 +0000 Subject: [PATCH] Update the documentation pages --- guide/getting-started.html | 2 +- guide/migration.html | 10 +++++----- manifest.json | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/guide/getting-started.html b/guide/getting-started.html index 21beec7..fbf1473 100644 --- a/guide/getting-started.html +++ b/guide/getting-started.html @@ -171,7 +171,7 @@ Here's an example for the client credentials grant, used in machine-to-machi // to replace the default OpenIddict entities. options.UseOpenIddict(); }); -
Warning

Important: if you change the default entity primary key (e.g. to int or Guid instead of string), make sure you use the options.ReplaceDefaultEntities<TKey>() +

Warning

If you change the default entity primary key (e.g. to int or Guid instead of string), make sure you use the options.ReplaceDefaultEntities<TKey>() core extension accepting a TKey generic argument and use the generic options.UseOpenIddict<TKey>() overload to configure EF Core to use the specified type:

services.AddOpenIddict()
     .AddCore(options =>
diff --git a/guide/migration.html b/guide/migration.html
index 97ac0ea..41fc4f3 100644
--- a/guide/migration.html
+++ b/guide/migration.html
@@ -98,10 +98,10 @@
   <PackageReference Include="OpenIddict" Version="2.0.0-rc3-final" />
   <PackageReference Include="OpenIddict.EntityFrameworkCore" Version="2.0.0-rc3-final" />
 </ItemGroup>
-
Tip

Note: if you have an explicit reference to AspNet.Security.OAuth.Validation or OpenIddict.Mvc, +

Tip

If you have an explicit reference to AspNet.Security.OAuth.Validation or OpenIddict.Mvc, you can safely remove these dependencies: they are now transitively referenced by the OpenIddict metapackage.

-
Important

Note: if your application references OpenIddict.Models or OpenIddict.Stores, you MUST remove them as these packages are no longer used in rc3.

+
Important

If your application references OpenIddict.Models or OpenIddict.Stores, you MUST remove them as these packages are no longer used in rc3.

Use the new OpenIddict services registration APIs

To offer a better user experience, the registrations APIs exposed by OpenIddict have been reworked. Updating your code should be quite straightforward:

@@ -184,7 +184,7 @@ services.AddAuthentication() // ... by: services.AddOpenIddict() .AddValidation(); -
Tip

Note: the OpenIddict validation handler lives in the OpenIddict.Validation package, which is referenced by the OpenIddict metapackage. +

Tip

The OpenIddict validation handler lives in the OpenIddict.Validation package, which is referenced by the OpenIddict metapackage. You don't have to explicitly add a new PackageReference in your .csproj file to be able to use it.

If necessary, create new application entries

@@ -279,9 +279,9 @@ and new features like application permissions, that allow limit

Migrating to OpenIddict rc2 (1.0.0-rc2-final and 2.0.0-rc2-final) requires making changes in your database: existing properties have been reworked (e.g to work around a MySQL limitation) and new ones have been added to support the new features. This procedure is quite easy and only requires a few minutes.

-

Note: this guide assumes your application uses the OpenIddict Entity Framework Core 2.x stores. If you use a custom store, changes will have to be made manually. +

Tip

This guide assumes your application uses the OpenIddict Entity Framework Core 2.x stores. If you use a custom store, changes will have to be made manually. A list of added/updated/renamed columns is available at the end of this guide.

-
+

Ensure migrations are correctly enabled for your project

Before migrating to OpenIddict rc2, make sure migrations are already enabled for your application. If you have a Migrations folder in your application root folder and an __EFMigrationsHistory table in your database, you're good to go.

diff --git a/manifest.json b/manifest.json index d7fa4d9..2ebab98 100644 --- a/manifest.json +++ b/manifest.json @@ -45,7 +45,7 @@ "output": { ".html": { "relative_path": "guide/getting-started.html", - "hash": "+jOyF8NSMA1jX6YFLsLZ2g==" + "hash": "k1o8zpuQI9iJpTrsbnkNzg==" } }, "is_incremental": false, @@ -69,7 +69,7 @@ "output": { ".html": { "relative_path": "guide/migration.html", - "hash": "bvvYc3G4nMiAfEPUg03lxg==" + "hash": "aAwfoySJhpae4kPX3x95Yw==" } }, "is_incremental": false,