dotnet/entityframework.apidocs

Reference documentation for Entity Framework APIs

This repository only contains infrastructure and metadata for building the Entity Framework Core and the Entity Framework 6 API reference documentation. Changes to the actual contents of the API documentation need to be made in the source code of EF Core or in the source code of EF6.

See Contributing for more information.

entityframework.apidocs's Issues

Duplicate info Duplicate info

A lot of the EF Core API Doc elements are being rendered twice.

Here's some duplicates from https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.relationaldatabasefacadeextensions.setcommandtimeout?view=efcore-2.0:

On https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.infrastructure.databasefacade?view=efcore-2.0, I'm seeing triples:

incorrect links

From @StillLearnin on July 10, 2018 21:37

Two APIs are marked as obsolete but the links to what we should use instead simply take us to the obsolete APIs

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 9e9c2511-ca2d-999e-dcb9-25a46ba085c3
• Version Independent ID: c5804fd3-45b3-223a-c2be-f40386915fc2
• Content: InMemoryDbContextOptionsExtensions.UseInMemoryDatabase Method (Microsoft.EntityFrameworkCore)
• Content Source: dotnet/xml/Microsoft.EntityFrameworkCore/InMemoryDbContextOptionsExtensions.xml
• GitHub Login: @dotnet-bot

Copied from original issue: dotnet/EntityFramework.Docs#827

C# code snippets shown when VB filter is selected

This still not fixed after the fix for #18.

Repro steps:

1. Navigate to https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.relationaldatabasefacadeextensions.setcommandtimeout?view=efcore-2.1
2. Select VB from the language drop down

Result:

C# snippet is shown. The C# and F# options in the drop down seem to be working correctly.

cc @dend @mairaw

Not working web link for bulk operations

In the documentation of new bulk methods, the documentation link is not working

This link precisely:

EntityFramework.ApiDocs/dotnet/xml/Microsoft.EntityFrameworkCore/RelationalQueryableExtensions.xml

Line 215 in 328d2b1

See <see href="https://aka.ms/efcore-docs-bulk-operations">Executing bulk operations with EF Core</see>

Return a 302 Moved Temporarily to https://www.bing.com?ref=aka&shorturl=efcore-docs-bulk-operations which return nothing (Bing don't seems to understand what to do with it and stay at landing page).

Links to documentation like that will be very helpful to maintains code, please fix it and add new ones when possible :)

The <example> attribute is repeated two or three times in XML files

See PR that was sent to fix this in one of our classes. It turns out that it happens on other classes too, but the source code only contains one copy of the <example> attribute:

#30.

Generate API docs for EF Core 2.2

We need the API for the 2.2.0 version of the packages 2.2.0 in the API browser.

More internal namespaces to filter

Since now we have API docs for 2.2 & 3.0 also, there are few more internal namespaces we need to filter out.

Microsoft.EntityFrameworkCore.Cosmos.Diagnostics.Internal
Microsoft.EntityFrameworkCore.Cosmos.Infrastructure.Internal
Microsoft.EntityFrameworkCore.Cosmos.Internal
Microsoft.EntityFrameworkCore.Cosmos.Metadata.Conventions.Internal
Microsoft.EntityFrameworkCore.Cosmos.Metadata.Internal
Microsoft.EntityFrameworkCore.Cosmos.Query.Internal
Microsoft.EntityFrameworkCore.Cosmos.Storage.Internal
Microsoft.EntityFrameworkCore.Cosmos.Update.Internal
Microsoft.EntityFrameworkCore.Cosmos.ValueGeneration.Internal
Microsoft.EntityFrameworkCore.Diagnostics.Internal
Microsoft.EntityFrameworkCore.InMemory.Diagnostics.Internal
Microsoft.EntityFrameworkCore.Sqlite.Diagnostics.Internal
Microsoft.EntityFrameworkCore.Sqlite.Query.Internal
Microsoft.EntityFrameworkCore.Sqlite.Storage.ValueConversion.Internal
Microsoft.EntityFrameworkCore.SqlServer.Diagnostics.Internal
Microsoft.EntityFrameworkCore.SqlServer.Storage.ValueConversion.Internal

Default branch will be renamed to 'main'

On March 8th, 2021, we're going to rename the default branch in this repository to main. For more details, see dotnet's earlier announcement.

Cleanup: remove Internal namespaces from API reference

From @divega on June 5, 2017 22:18

E.g. https://docs.microsoft.com/en-us/ef/core/api/microsoft.entityframeworkcore.design.internal.

Copied from original issue: dotnet/EntityFramework.Docs#402

Remove links to the Internal namespaces

While the pages for the Internal namespaces aren't generated anymore the links are still present at https://docs.microsoft.com/en-us/dotnet/api/?view=efcore-3.0

Move EF6, EF5, and EF4.3.1 API reference to Docs

The API references for the non-core versions of the NuGet package should be part of the .NET API Browser. I talked to @dend and apparently they can be hosted in this repo.

To have complete coverage we discussed having the API reference generated for the following EntityFramework package versions:

• https://www.nuget.org/packages/EntityFramework/6.2.0
• https://www.nuget.org/packages/EntityFramework/5.0.0
• https://www.nuget.org/packages/EntityFramework/4.3.1

Current locations which need to be redirected

• EF6

  • https://msdn.microsoft.com/library/dn223258(v=vs.113).aspx (our conceptual docs point here)
  • https://msdn.microsoft.com/en-us/library/mt154346(v=vs.113).aspx (duplicate)

• EF5

  • https://msdn.microsoft.com/en-us/library/hh289362(v=vs.103).aspx

API browser is empty for EF 5 and EF 4.3.1

The fix for #26 added the API reference of EF 6 at https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-6.2.0, but other versions are still empty:

https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-5.0.0

https://docs.microsoft.com/en-us/dotnet/api/?view=entity-framework-4.3.1

cc @dend @Sampy @sudeepku

Clean up obsolete API reference?

We moved our API reference to the .NET site, but the old API reference is still in place at https://docs.microsoft.com/en-us/ef/core/api/microsoft.entityframeworkcore.

There is perhaps some value in keeping it in case there are external things pointing to it but on the other hand it does no good if it is stale.

cc @dend.

Incorrect documentation generated for methods which changed return type

EF Core has API over DbSet<T> - AddAsync which returned task in past. In 3.0 release, we changed it to return ValueTask instead.

Generated xml content does not contain the change.

EntityFramework.ApiDocs/dotnet/xml/Microsoft.EntityFrameworkCore/DbSet`1.xml

Lines 152 to 170 in 796ac2b

	<Member MemberName="AddAsync">
	<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task&lt;Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry&lt;TEntity&gt;&gt; AddAsync (TEntity entity, System.Threading.CancellationToken cancellationToken = null);" FrameworkAlternate="efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
	<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry`1&lt;!TEntity&gt;&gt; AddAsync(!TEntity entity, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
	<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.DbSet`1.AddAsync(`0,System.Threading.CancellationToken)" FrameworkAlternate="efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
	<MemberSignature Language="F#" Value="abstract member AddAsync : 'Entity * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry&lt;'Entity&gt;&gt;&#xA;override this.AddAsync : 'Entity * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry&lt;'Entity&gt;&gt;" Usage="dbSet.AddAsync (entity, cancellationToken)" FrameworkAlternate="efcore-1.1;efcore-2.0;efcore-2.1;efcore-2.2" />
	<MemberType>Method</MemberType>
	<AssemblyInfo>
	<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
	<AssemblyVersion>1.1.0.0</AssemblyVersion>
	<AssemblyVersion>1.1.6.0</AssemblyVersion>
	<AssemblyVersion>2.0.0.0</AssemblyVersion>
	<AssemblyVersion>2.0.3.0</AssemblyVersion>
	<AssemblyVersion>2.1.0.0</AssemblyVersion>
	<AssemblyVersion>2.1.11.0</AssemblyVersion>
	<AssemblyVersion>2.2.6.0</AssemblyVersion>
	</AssemblyInfo>
	<ReturnValue>
	<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry&lt;TEntity&gt;&gt;</ReturnType>
	</ReturnValue>

XML mentions about API returning Task. Also assemblies specified does not include 3.x onward.
So for 3.x we did not generate API in xml for this method.

At the same time,
On doc page, https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbset-1.addasync?view=efcore-3.1#applies-to

It says that it is applicable to 3.0 & 3.1. Not sure why it computed that.

It seems that this is issue somewhere in reference doc generation.

cc: @scottaddie

Consider adding templates that discourages creating issues or PRs about contents or tooling here

• Issues about content should go in the EF Core or EF6 repos
• Issues about incorrectly generated docs from correct documentation need to go in whatever repo is used to develop the tools (not shure which one).

Otherwise can we can just disable issue tracking here and add the latter in the readme (the link to the product repos for content are already there).

SaveChangesAsync() doc page

Moved from dotnet/efcore#12751 posted by @erictrigo

Check out: https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.savechangesasync?view=efcore-2.1

Says signature for SaveChangesAsync is

public virtual System.Threading.Tasks.Task<int> SaveChangesAsync (System.Threading.CancellationToken cancellationToken = null);

If you try overriding SaveChangesAsync using the above example, it'll give you the following error:

Using default(CancellationToken) instead of null solves the issue:
public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default(CancellationToken))