Skip to content

Commit e0afc9a

Browse files
committed
Auto-generated documentation from a7b8a3e
1 parent e42e74d commit e0afc9a

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

getting-started/faq.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,11 @@ <h1 id="frequently-asked-questions">Frequently Asked Questions</h1>
8686
<h4 id="where-can-i-find-documentation-and-examples">Where can I find documentation and examples?</h4>
8787
<p>While the <a href="../usage/resources/index.html">documentation</a> covers basic features and a few runnable example projects are available <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples">here</a>,
8888
many more advanced use cases are available as integration tests <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/test/JsonApiDotNetCoreTests/IntegrationTests">here</a>, so be sure to check them out!</p>
89-
<h4 id="why-cant-i-use-openapi">Why can't I use OpenAPI?</h4>
90-
<p>Due to the mismatch between the JSON:API structure and the shape of ASP.NET controller methods, this does not work out of the box.
91-
This is high on our agenda and we're steadily making progress, but it's quite complex and far from complete.
92-
See <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1046">here</a> for the current status, which includes instructions on trying out the latest build.</p>
89+
<h4 id="why-dont-you-use-the-built-in-openapi-support-in-aspnet-core">Why don't you use the built-in OpenAPI support in ASP.NET Core?</h4>
90+
<p>The structure of JSON:API request and response bodies differs significantly from the signature of JsonApiDotNetCore controllers.
91+
JsonApiDotNetCore provides OpenAPI support using <a href="https://github.com/domaindrivendev/Swashbuckle.AspNetCore">Swashbuckle</a>, a mature and feature-rich library that is highly extensible.
92+
The <a href="https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview">OpenAPI support in ASP.NET Core</a> is still very young
93+
and doesn't provide the level of extensibility needed for JsonApiDotNetCore.</p>
9394
<h4 id="whats-available-to-implement-a-jsonapi-client">What's available to implement a JSON:API client?</h4>
9495
<p>It depends on the programming language used. There's an overwhelming list of client libraries at <a href="https://jsonapi.org/implementations/#client-libraries">https://jsonapi.org/implementations/#client-libraries</a>.</p>
9596
<p>The JSON object model inside JsonApiDotNetCore is tweaked for server-side handling (be tolerant at inputs and strict at outputs).

usage/common-pitfalls.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ <h4 id="you-cant-mix-up-pipeline-methods">You can't mix up pipeline methods</h4>
207207
<p>If you need such side effects, it's easiest to inject your <code>DbContext</code> in the controller, directly apply the changes on it and save.
208208
A better way is to inject your <code>DbContext</code> in a <a href="extensibility/resource-definitions.html">Resource Definition</a> and apply the changes there.</p>
209209
<h4 id="concurrency-tokens-timestamprowversionxmin-wont-work">Concurrency tokens (timestamp/rowversion/xmin) won't work</h4>
210-
<p>While we'd love to support such <a href="https://learn.microsoft.com/ef/core/saving/concurrency?tabs=data-annotations">tokens for optimistic concurrency</a>,
210+
<p>While we'd love to support such <a href="https://learn.microsoft.com/ef/core/saving/concurrency">tokens for optimistic concurrency</a>,
211211
it turns out that the implementation is far from trivial. We've come a long way, but aren't sure how it should work when relationship endpoints and atomic operations are involved.
212212
If you're interested, we welcome your feedback at <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1119">https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1119</a>.</p>
213213

0 commit comments

Comments
 (0)