Skip to content

Commit a8711f3

Browse files
committed
Updated roadmap and documentation
1 parent 50fe66f commit a8711f3

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

ROADMAP.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ This document provides an overview of the direction this project is heading and
66
77
We have an interest in the following topics. It's too soon yet to decide whether they'll make it into v5.x or in a later major version.
88

9-
- OpenAPI (Swagger): Generate documentation and typed clients [#1046](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1046)
9+
- Provide additional OpenAPI support [#1046](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1046)
1010
- Query strings on JSON-mapped columns [#1439](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1439)
11+
- Improved resource inheritance [#1642](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1642)
1112
- Improved SQL Server support [#1118](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1118)
13+
- Use incremental source generator [#1447](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1447)
1214
- Optimistic concurrency [#1119](https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1119)
13-
- Fluent API [#776](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/776)
1415
- Idempotency [#1132](https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1132)
16+
- Fluent API [#776](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/776)
1517

1618
## Feedback
1719

docs/getting-started/faq.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
While the [documentation](~/usage/resources/index.md) covers basic features and a few runnable example projects are available [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples),
55
many more advanced use cases are available as integration tests [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/test/JsonApiDotNetCoreTests/IntegrationTests), so be sure to check them out!
66

7-
#### Why can't I use OpenAPI?
8-
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.
9-
This is high on our agenda and we're steadily making progress, but it's quite complex and far from complete.
10-
See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1046) for the current status, which includes instructions on trying out the latest build.
7+
#### Why don't you use the built-in OpenAPI support in ASP.NET Core?
8+
The structure of JSON:API request and response bodies differs significantly from the signature of JsonApiDotNetCore controllers.
9+
JsonApiDotNetCore provides OpenAPI support using [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle.AspNetCore), a mature and feature-rich library that is highly extensible.
10+
The [OpenAPI support in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview) is still very young
11+
and doesn't provide the level of extensibility needed for JsonApiDotNetCore.
1112

1213
#### What's available to implement a JSON:API client?
1314
It depends on the programming language used. There's an overwhelming list of client libraries at https://jsonapi.org/implementations/#client-libraries.

docs/usage/common-pitfalls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,6 @@ If you need such side effects, it's easiest to inject your `DbContext` in the co
145145
A better way is to inject your `DbContext` in a [Resource Definition](~/usage/extensibility/resource-definitions.md) and apply the changes there.
146146

147147
#### Concurrency tokens (timestamp/rowversion/xmin) won't work
148-
While we'd love to support such [tokens for optimistic concurrency](https://learn.microsoft.com/ef/core/saving/concurrency?tabs=data-annotations),
148+
While we'd love to support such [tokens for optimistic concurrency](https://learn.microsoft.com/ef/core/saving/concurrency),
149149
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.
150150
If you're interested, we welcome your feedback at https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1119.

0 commit comments

Comments
 (0)