Skip to content

Commit 4a2be4f

Browse files
committed
update docs
1 parent 2e58b91 commit 4a2be4f

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

‎docs/docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ app.Run();
8383
This sets up a `HTTP` `POST` end point at `/graphql` where the body of the post is expected to be a GraphQL query. You can change the path with the `path` argument in `MapGraphQL<T>()`
8484

8585
:::tip
86-
`MapGraphQL` follows the GraphQL over HTTP behavior that EntityGraphQL adopted in v6. GraphQL execution errors are returned in the GraphQL response body rather than by changing the route shape or adding a special endpoint mode.
86+
`MapGraphQL` follows the [GraphQL over HTTP spec](https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md). GraphQL errors are returned in the response body - always read `errors` there. See [Tool integration](./integration) for the status codes used.
8787
:::
8888

8989
_You can authorize the route how ever you wish using ASP.NET. See the Authorization section for more details._

‎docs/docs/integration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Being GraphQL there are many tools that integrate well with EntityGraphQL.
99
EntityGraphQL supports GraphQL introspection queries so tools like GraphiQL and Relay can work against your schema.
1010

1111
:::tip GraphQL over HTTP
12-
`MapGraphQL()` follows the [GraphQL over HTTP spec](https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md), the behavior EntityGraphQL adopted in v6. GraphQL execution errors are returned in the GraphQL response body rather than by changing the route shape or adding a special endpoint mode. HTTP status codes follow the spec per negotiated media type: with `application/graphql-response+json` (the default) a request error (no `data` in the response) returns `400`, a partial success (`data` plus `errors`) returns `294` and a clean result `200`; with the legacy `application/json` every well-formed request returns `200` and clients must read the body. Either way, always read `errors` from the response body.
12+
`MapGraphQL()` follows the [GraphQL over HTTP spec](https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md) (adopted in v6). GraphQL errors are returned in the response body - always read `errors` there. Status codes follow the spec: with `application/graphql-response+json` (the default) a request error returns `400` and a partial success `294`; with legacy `application/json` every well-formed request returns `200`.
1313
:::
1414

1515
## Introspection

‎docs/static/img/favicon.ico‎

-20 Bytes
Binary file not shown.

‎docs/static/img/logo.svg‎

Lines changed: 11 additions & 11 deletions
Loading

0 commit comments

Comments
 (0)