Skip to content
Next Next commit
Trim trailing whitespace from files
  • Loading branch information
bkoelman committed Apr 6, 2025
commit b48e5691f44adcdc8012383a6d5ba4dfa46a85ad
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Bugs are tracked as [GitHub issues](https://github.com/json-api-dotnet/JsonApiDo
Explain the problem and include additional details to help maintainers reproduce the problem:

- **Use a clear and descriptive title** for the issue to identify the problem.
- **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- **Provide specific examples to demonstrate the steps.** Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks).
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. Explain which behavior you expected to see instead and why.
- **If you're reporting a crash**, include the full exception stack trace.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ To try it out, follow the steps below:
In the command above:
- Replace YOUR-GITHUB-USERNAME with the username you use to login your GitHub account.
- Replace YOUR-PAT-CLASSIC with the token your created above.

:warning: If the above command doesn't give you access in the next step, remove the package source by running:
```bash
dotnet nuget remove source github-json-api
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/extensibility/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
The default middleware validates incoming `Content-Type` and `Accept` HTTP headers.
Based on routing configuration, it fills `IJsonApiRequest`, an injectable object that contains JSON:API-related information about the request being processed.

It is possible to replace the built-in middleware components by configuring the IoC container and by configuring `MvcOptions`.
It is possible to replace the built-in middleware components by configuring the IoC container and by configuring `MvcOptions`.

## Configuring the IoC container
## Configuring the IoC container

The following example replaces the internal exception filter with a custom implementation.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/extensibility/resource-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For various reasons (see examples below) you may need to change parts of the que
`JsonApiResourceDefinition<TResource, TId>` (which is an empty implementation of `IResourceDefinition<TResource, TId>`) provides overridable methods that pass you the result of query string parameter parsing.
The value returned by you determines what will be used to execute the query.

An intermediate format (`QueryExpression` and derived types) is used, which enables us to separate JSON:API implementation
An intermediate format (`QueryExpression` and derived types) is used, which enables us to separate JSON:API implementation
from Entity Framework Core `IQueryable` execution.

### Excluding fields
Expand Down Expand Up @@ -220,7 +220,7 @@ You can define additional query string parameters with the LINQ expression that
If the key is present in a query string, the supplied LINQ expression will be added to the database query.

> [!NOTE]
> This directly influences the Entity Framework Core `IQueryable`. As opposed to using `OnApplyFilter`, this enables the full range of Entity Framework Core operators.
> This directly influences the Entity Framework Core `IQueryable`. As opposed to using `OnApplyFilter`, 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).

```c#
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/reading/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The next request returns all customers that have orders -or- whose last name is
GET /customers?filter=has(orders)&filter=equals(lastName,'Smith') HTTP/1.1
```

Aside from filtering on the resource being requested (which would be blogs in /blogs and articles in /blogs/1/articles),
Aside from filtering on the resource being requested (which would be blogs in /blogs and articles in /blogs/1/articles),
filtering on to-many relationships can be done using bracket notation:

```http
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/resource-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ There are three ways the resource graph can be created:
2. Specifying an entire DbContext
3. Manually specifying each resource

It is also possible to combine the three of them at once. Be aware that some configuration might overlap,
It is also possible to combine the three of them at once. Be aware that some configuration might overlap,
for example one could manually add a resource to the graph which is also auto-discovered. In such a scenario, the configuration
is prioritized by the list above in descending order.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/resources/relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,8 @@ public class TodoItem : Identifiable<int>

_since v5.1_

Default JSON:API relationship capabilities are specified in
@JsonApiDotNetCore.Configuration.JsonApiOptions#JsonApiDotNetCore_Configuration_JsonApiOptions_DefaultHasOneCapabilities and
Default JSON:API relationship capabilities are specified in
@JsonApiDotNetCore.Configuration.JsonApiOptions#JsonApiDotNetCore_Configuration_JsonApiOptions_DefaultHasOneCapabilities and
@JsonApiDotNetCore.Configuration.JsonApiOptions#JsonApiDotNetCore_Configuration_JsonApiOptions_DefaultHasManyCapabilities:

```c#
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/writing/bulk-batch-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public sealed class OperationsController : JsonApiOperationsController
}
```

> [!IMPORTANT]
> [!IMPORTANT]
> Since v5.6.0, the set of exposed operations is based on
> [`GenerateControllerEndpoints` usage](~/usage/extensibility/controllers.md#resource-access-control).
> Earlier versions always exposed all operations for all resource types.
Expand Down
2 changes: 1 addition & 1 deletion test/SourceGeneratorTests/ControllerGenerationTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public sealed class Item : Identifiable<long>
{
private const JsonApiEndpoints NoRelationshipEndpoints = JsonApiEndpoints.GetCollection |
JsonApiEndpoints.GetSingle | JsonApiEndpoints.Post | JsonApiEndpoints.Patch | JsonApiEndpoints.Delete;

[Attr]
public int Value { get; set; }
}
Expand Down
Loading