Auto-generated documentation from 3cd643a

Author: bkoelman

sitemap.xml

@@ -113,9 +113,9 @@ <h1 id="exception-handling">Exception handling</h1>
 This handler is also the place to choose the log level and message, based on the exception type.</p>
 <pre><code class="lang-c#">public class ProductOutOfStockException : Exception
 {
-    public int ProductId { get; }
+    public long ProductId { get; }
 
-    public ProductOutOfStockException(int productId)
+    public ProductOutOfStockException(long productId)
     {
         ProductId = productId;
     }

usage/errors.html

@@ -183,10 +183,10 @@ <h3 id="resource-access-control-1">Resource Access Control</h3>
 Likewise, to provide write-only access, inherit from <code>JsonApiCommandController</code>, which blocks all GET and HEAD requests.</p>
 <p>You can even make your own mix of allowed routes by calling the alternate constructor of <code>JsonApiController</code> and injecting the set of service implementations available.
 In some cases, resources may be an aggregation of entities or a view on top of the underlying entities. In these cases, there may not be a writable <code>IResourceService</code> implementation, so simply inject the implementation that is available.</p>
-<pre><code class="lang-c#">public class ReportsController : JsonApiController&lt;Report, int&gt;
+<pre><code class="lang-c#">public class ReportsController : JsonApiController&lt;Report, long&gt;
 {
     public ReportsController(IJsonApiOptions options, IResourceGraph resourceGraph,
-        ILoggerFactory loggerFactory, IGetAllService&lt;Report, int&gt; getAllService)
+        ILoggerFactory loggerFactory, IGetAllService&lt;Report, long&gt; getAllService)
         : base(options, resourceGraph, loggerFactory, getAll: getAllService)
     {
     }

usage/extensibility/controllers.html

@@ -93,9 +93,9 @@ <h1 id="resource-repositories">Resource Repositories</h1>
 <p>If you want to use a data access technology other than Entity Framework Core, you can create an implementation of <code>IResourceRepository&lt;TResource, TId&gt;</code>.
 If you only need minor changes you can override the methods defined in <code>EntityFrameworkCoreRepository&lt;TResource, TId&gt;</code>.</p>
 <pre><code class="lang-c#">// Program.cs
-builder.Services.AddScoped&lt;IResourceRepository&lt;Article, int&gt;, ArticleRepository&gt;();
-builder.Services.AddScoped&lt;IResourceReadRepository&lt;Article, int&gt;, ArticleRepository&gt;();
-builder.Services.AddScoped&lt;IResourceWriteRepository&lt;Article, int&gt;, ArticleRepository&gt;();
+builder.Services.AddScoped&lt;IResourceRepository&lt;Article, long&gt;, ArticleRepository&gt;();
+builder.Services.AddScoped&lt;IResourceReadRepository&lt;Article, long&gt;, ArticleRepository&gt;();
+builder.Services.AddScoped&lt;IResourceWriteRepository&lt;Article, long&gt;, ArticleRepository&gt;();
 </code></pre>
 <p>In v4.0 we introduced an extension method that you can use to register a resource repository on all of its JsonApiDotNetCore interfaces.
 This is helpful when you implement (a subset of) the resource interfaces and want to register them all in one go.</p>
@@ -108,7 +108,7 @@ <h5>Tip</h5>
 </div>
 <p>A sample implementation that performs authorization might look like this.</p>
 <p>All of the methods in EntityFrameworkCoreRepository will use the <code>GetAll()</code> method to get the <code>DbSet&lt;TResource&gt;</code>, so this is a good method to apply filters such as user or tenant authorization.</p>
-<pre><code class="lang-c#">public class ArticleRepository : EntityFrameworkCoreRepository&lt;Article, int&gt;
+<pre><code class="lang-c#">public class ArticleRepository : EntityFrameworkCoreRepository&lt;Article, long&gt;
 {
     private readonly IAuthenticationService _authenticationService;
 

usage/extensibility/repositories.html

@@ -104,7 +104,7 @@ <h5>Tip</h5>
 <div class="NOTE">
 <h5>Note</h5>
 <p>Prior to the introduction of auto-discovery (in v3), you needed to register the resource definition on the container yourself:</p>
-<pre><code class="lang-c#">builder.Services.AddScoped&lt;ResourceDefinition&lt;Article, int&gt;, ArticleDefinition&gt;();
+<pre><code class="lang-c#">builder.Services.AddScoped&lt;ResourceDefinition&lt;Article, long&gt;, ArticleDefinition&gt;();
 </code></pre>
 </div>
 <h2 id="customizing-queries">Customizing queries</h2>
@@ -121,7 +121,7 @@ <h3 id="excluding-fields">Excluding fields</h3>
 <h5>Note</h5>
 <p>To exclude fields unconditionally, <a href="../resources/attributes.html#capabilities">attribute capabilities</a> and <a href="../resources/relationships.html#capabilities">relationship capabilities</a> can be used instead.</p>
 </div>
-<pre><code class="lang-c#">public class UserDefinition : JsonApiResourceDefinition&lt;User, int&gt;
+<pre><code class="lang-c#">public class UserDefinition : JsonApiResourceDefinition&lt;User, long&gt;
 {
     public UserDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -171,7 +171,7 @@ <h5>Note</h5>
 </code></pre>
 <h3 id="default-sort-order">Default sort order</h3>
 <p>You can define the default sort order if no <code>sort</code> query string parameter is provided.</p>
-<pre><code class="lang-c#">public class AccountDefinition : JsonApiResourceDefinition&lt;Account, int&gt;
+<pre><code class="lang-c#">public class AccountDefinition : JsonApiResourceDefinition&lt;Account, long&gt;
 {
     public AccountDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -195,7 +195,7 @@ <h3 id="default-sort-order">Default sort order</h3>
 </code></pre>
 <h3 id="enforce-page-size">Enforce page size</h3>
 <p>You may want to enforce pagination on large database tables.</p>
-<pre><code class="lang-c#">public class AccessLogDefinition : JsonApiResourceDefinition&lt;AccessLog, int&gt;
+<pre><code class="lang-c#">public class AccessLogDefinition : JsonApiResourceDefinition&lt;AccessLog, long&gt;
 {
     public AccessLogDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -222,7 +222,7 @@ <h3 id="enforce-page-size">Enforce page size</h3>
 </code></pre>
 <h3 id="change-filters">Change filters</h3>
 <p>The next example filters out <code>Account</code> resources that are suspended.</p>
-<pre><code class="lang-c#">public class AccountDefinition : JsonApiResourceDefinition&lt;Account, int&gt;
+<pre><code class="lang-c#">public class AccountDefinition : JsonApiResourceDefinition&lt;Account, long&gt;
 {
     public AccountDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -247,7 +247,7 @@ <h3 id="change-filters">Change filters</h3>
 </code></pre>
 <h3 id="block-including-related-resources">Block including related resources</h3>
 <p>In the example below, an error is returned when a user tries to include the manager of an employee.</p>
-<pre><code class="lang-c#">public class EmployeeDefinition : JsonApiResourceDefinition&lt;Employee, int&gt;
+<pre><code class="lang-c#">public class EmployeeDefinition : JsonApiResourceDefinition&lt;Employee, long&gt;
 {
     public EmployeeDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -279,7 +279,7 @@ <h5>Note</h5>
 <p>This directly influences the Entity Framework Core <code>IQueryable</code>. As opposed to using <code>OnApplyFilter</code>, this enables the full range of Entity Framework Core operators.
 But it only works on primary resource endpoints (for example: /articles, but not on /blogs/1/articles or /blogs?include=articles).</p>
 </div>
-<pre><code class="lang-c#">public class ItemDefinition : JsonApiResourceDefinition&lt;Item, int&gt;
+<pre><code class="lang-c#">public class ItemDefinition : JsonApiResourceDefinition&lt;Item, long&gt;
 {
     public ItemDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)

usage/extensibility/resource-definitions.html

@@ -97,7 +97,7 @@ <h2 id="supplementing-default-behavior">Supplementing Default Behavior</h2>
 <p>If you don't need to alter the underlying mechanisms, you can inherit from <code>JsonApiResourceService&lt;TResource, TId&gt;</code> and override the existing methods.
 In simple cases, you can also just wrap the base implementation with your custom logic.</p>
 <p>A simple example would be to send notifications when a resource gets created.</p>
-<pre><code class="lang-c#">public class TodoItemService : JsonApiResourceService&lt;TodoItem, int&gt;
+<pre><code class="lang-c#">public class TodoItemService : JsonApiResourceService&lt;TodoItem, long&gt;
 {
     private readonly INotificationService _notificationService;
 
@@ -132,14 +132,14 @@ <h2 id="not-using-entity-framework-core">Not Using Entity Framework Core?</h2>
 <pre><code class="lang-c#">// Program.cs
 
 // Add the service override for Product.
-builder.Services.AddScoped&lt;IResourceService&lt;Product, int&gt;, ProductService&gt;();
+builder.Services.AddScoped&lt;IResourceService&lt;Product, long&gt;, ProductService&gt;();
 
 // Add your own Data Access Object.
 builder.Services.AddScoped&lt;IProductDao, ProductDao&gt;();
 
 // ProductService.cs
 
-public class ProductService : IResourceService&lt;Product, int&gt;
+public class ProductService : IResourceService&lt;Product, long&gt;
 {
     private readonly IProductDao _dao;
 
@@ -187,14 +187,14 @@ <h2 id="limited-requirements">Limited Requirements</h2>
 IResourceCommandService &lt;|-- IRemoveFromRelationshipService
 </code></pre>
 <p>In order to take advantage of these interfaces you first need to register the service for each implemented interface.</p>
-<pre><code class="lang-c#">public class ArticleService : ICreateService&lt;Article, int&gt;, IDeleteService&lt;Article, int&gt;
+<pre><code class="lang-c#">public class ArticleService : ICreateService&lt;Article, long&gt;, IDeleteService&lt;Article, long&gt;
 {
     // ...
 }
 
 // Program.cs
-builder.Services.AddScoped&lt;ICreateService&lt;Article, int&gt;, ArticleService&gt;();
-builder.Services.AddScoped&lt;IDeleteService&lt;Article, int&gt;, ArticleService&gt;();
+builder.Services.AddScoped&lt;ICreateService&lt;Article, long&gt;, ArticleService&gt;();
+builder.Services.AddScoped&lt;IDeleteService&lt;Article, long&gt;, ArticleService&gt;();
 </code></pre>
 <p>In v3.0 we introduced an extension method that you can use to register a resource service on all of its JsonApiDotNetCore interfaces.
 This is helpful when you implement (a subset of) the resource interfaces and want to register them all in one go.</p>
@@ -208,17 +208,17 @@ <h5>Tip</h5>
 <p>Then on your model, pass in the set of endpoints to expose (the ones that you've registered services for):</p>
 <pre><code class="lang-c#">[Resource(GenerateControllerEndpoints =
     JsonApiEndpoints.Create | JsonApiEndpoints.Delete)]
-public class Article : Identifiable&lt;int&gt;
+public class Article : Identifiable&lt;long&gt;
 {
     // ...
 }
 </code></pre>
 <p>Alternatively, when using a hand-written controller, you should inherit from the JSON:API controller and pass the services into the named, optional base parameters:</p>
-<pre><code class="lang-c#">public class ArticlesController : JsonApiController&lt;Article, int&gt;
+<pre><code class="lang-c#">public class ArticlesController : JsonApiController&lt;Article, long&gt;
 {
     public ArticlesController(IJsonApiOptions options, IResourceGraph resourceGraph,
-        ILoggerFactory loggerFactory, ICreateService&lt;Article, int&gt; create,
-        IDeleteService&lt;Article, int&gt; delete)
+        ILoggerFactory loggerFactory, ICreateService&lt;Article, long&gt; create,
+        IDeleteService&lt;Article, long&gt; delete)
         : base(options, resourceGraph, loggerFactory, create: create, delete: delete)
     {
     }

usage/extensibility/services.html

@@ -127,7 +127,7 @@ <h2 id="resource-meta">Resource Meta</h2>
 <p>Resource-specific metadata can be added by implementing <code>IResourceDefinition&lt;TResource, TId&gt;.GetMeta</code> (or overriding it on <code>JsonApiResourceDefinition&lt;TResource, TId&gt;</code>):</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class PersonDefinition : JsonApiResourceDefinition&lt;Person, int&gt;
+public class PersonDefinition : JsonApiResourceDefinition&lt;Person, long&gt;
 {
     public PersonDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)

usage/meta.html

@@ -181,7 +181,7 @@ <h2 id="modelstate-validation">ModelState Validation</h2>
 </code></pre>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr]
     [MinLength(3)]

usage/options.html

@@ -127,7 +127,7 @@ <h3 id="manual-specification">Manual Specification</h3>
 <p>You can manually construct the graph.</p>
 <pre><code class="lang-c#">// Program.cs
 builder.Services.AddJsonApi(resources: resourceGraphBuilder =&gt;
-    resourceGraphBuilder.Add&lt;Person, int&gt;());
+    resourceGraphBuilder.Add&lt;Person, long&gt;());
 </code></pre>
 <h2 id="resource-name">Resource Name</h2>
 <p>The public resource name is exposed through the <code>type</code> member in the JSON:API payload. This can be configured using the following approaches (in order of priority):</p>
@@ -137,22 +137,22 @@ <h2 id="resource-name">Resource Name</h2>
 <pre><code class="lang-c#">// Program.cs
 builder.Services.AddJsonApi(resources: resourceGraphBuilder =&gt;
 {
-    resourceGraphBuilder.Add&lt;Person, int&gt;(publicName: &quot;individuals&quot;);
+    resourceGraphBuilder.Add&lt;Person, long&gt;(publicName: &quot;individuals&quot;);
 });
 </code></pre>
 <ol start="2">
 <li>The <code>PublicName</code> property when a model is decorated with a <code>ResourceAttribute</code>.</li>
 </ol>
 <pre><code class="lang-c#">[Resource(PublicName = &quot;individuals&quot;)]
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
 }
 </code></pre>
 <ol start="3">
 <li>The configured naming convention (by default this is camel-case), after pluralization.</li>
 </ol>
 <pre><code class="lang-c#">// this will be registered as &quot;people&quot;
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
 }
 </code></pre>

usage/resource-graph.html

@@ -93,7 +93,7 @@ <h1 id="attributes">Attributes</h1>
 <p>If you want an attribute on your model to be publicly available, add the <code>AttrAttribute</code>.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr]
     public string? FirstName { get; set; }
@@ -111,7 +111,7 @@ <h2 id="name">Name</h2>
 </li>
 </ol>
 <pre><code class="lang-c#">#nullable enable
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr(PublicName = &quot;first-name&quot;)]
     public string? FirstName { get; set; }
@@ -128,7 +128,7 @@ <h3 id="allowview">AllowView</h3>
 Otherwise, the attribute is silently omitted.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class User : Identifiable&lt;int&gt;
+public class User : Identifiable&lt;long&gt;
 {
     [Attr(Capabilities = ~AttrCapabilities.AllowView)]
     public string Password { get; set; } = null!;
@@ -138,7 +138,7 @@ <h3 id="allowfilter">AllowFilter</h3>
 <p>Indicates whether the attribute can be filtered on. When not allowed and used in <code>?filter=</code>, an HTTP 400 is returned.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr(Capabilities = AttrCapabilities.AllowFilter)]
     public string? FirstName { get; set; }
@@ -148,7 +148,7 @@ <h3 id="allowsort">AllowSort</h3>
 <p>Indicates whether the attribute can be sorted on. When not allowed and used in <code>?sort=</code>, an HTTP 400 is returned.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr(Capabilities = ~AttrCapabilities.AllowSort)]
     public string? FirstName { get; set; }
@@ -158,7 +158,7 @@ <h3 id="allowcreate">AllowCreate</h3>
 <p>Indicates whether POST requests can assign the attribute value. When sent but not allowed, an HTTP 422 response is returned.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr(Capabilities = AttrCapabilities.AllowCreate)]
     public string? CreatorName { get; set; }
@@ -168,7 +168,7 @@ <h3 id="allowchange">AllowChange</h3>
 <p>Indicates whether PATCH requests can update the attribute value. When sent but not allowed, an HTTP 422 response is returned.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Person : Identifiable&lt;int&gt;
+public class Person : Identifiable&lt;long&gt;
 {
     [Attr(Capabilities = AttrCapabilities.AllowChange)]
     public string? FirstName { get; set; };
@@ -181,7 +181,7 @@ <h2 id="complex-attributes">Complex Attributes</h2>
 You can also use <a href="../options.html#customize-serializer-options">global options</a> to control the <code>JsonSerializer</code> behavior.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Foo : Identifiable&lt;int&gt;
+public class Foo : Identifiable&lt;long&gt;
 {
     [Attr]
     public Bar? Bar { get; set; }
@@ -200,7 +200,7 @@ <h2 id="complex-attributes">Complex Attributes</h2>
 and retrieval.</p>
 <pre><code class="lang-c#">#nullable enable
 
-public class Foo : Identifiable&lt;int&gt;
+public class Foo : Identifiable&lt;long&gt;
 {
     [Attr]
     [NotMapped]