Skip to content

Commit d7c1a08

Browse files
timbotnikshorgi
andauthored
Apply suggestions from code review
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
1 parent c57eb9d commit d7c1a08

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
### Added documentation for more GraphQL error codes that can occur during Router execution. ([PR #7160](https://github.com/apollographql/router/issues/7160))
1+
### Added documentation for more GraphQL error codes that can occur during router execution. ([PR #7160](https://github.com/apollographql/router/issues/7160))
22

3-
Added documentation for more GraphQL error codes that can occur during Router execution, including better differentiation between HTTP status codes and GraphQL error extensions codes.
3+
Added documentation for more GraphQL error codes that can occur during router execution, including better differentiation between HTTP status codes and GraphQL error extensions codes.
44

55
By [@timbotnik](https://github.com/timbotnik) in https://github.com/apollographql/router/pull/7160

docs/source/routing/errors.mdx

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Reference of error codes and HTTP status codes returned by Apollo G
66

77
Learn about error codes and HTTP response status codes returned by GraphOS Router and Apollo Router Core.
88

9-
## HTTP Status codes
9+
## HTTP status codes
1010

1111
<PropertyList kind="errCodes">
1212
<Property name="400" short="Bad request">
@@ -71,15 +71,15 @@ You can create Rhai scripts that throw custom status codes. See [Terminating cli
7171

7272
</Note>
7373

74-
## GraphQL Error codes
74+
## GraphQL error codes
7575

7676
GraphQL error codes can appear in client responses under `errors[].extensions.code`, which is an established convention found in [GraphQL error extensions](https://spec.graphql.org/October2021/#sec-Errors.Error-result-format). Learn how to see these error codes in Studio via [extended error metrics](/graphos/routing/graphos-reporting#enabling-extended-error-reporting).
7777

7878
<PropertyList kind="errCodes">
7979

8080
<Property name="CANNOT_SEND_PQ_ID_AND_BODY">
8181

82-
The operation could not be executed because sending a persisted query ID and a
82+
The operation was not executed because sending a persisted query ID and a
8383
body in the same request is disallowed.
8484

8585
</Property>
@@ -110,7 +110,7 @@ The response from a subgraph did not match the GraphQL schema.
110110
</Property>
111111
<Property name="GATEWAY_TIMEOUT">
112112

113-
There request timed out when fetching data from a connector service.
113+
The request timed out when fetching data from a connector service.
114114

115115
</Property>
116116
<Property name="GRAPHQL_VALIDATION_FAILED">
@@ -132,22 +132,22 @@ connector service.
132132
</Property>
133133
<Property name="MAX_ALIASES_LIMIT">
134134

135-
The operation was not executed due to exceeding the max_aliases limit.
135+
The operation was not executed due to exceeding the `max_aliases` limit.
136136

137137
</Property>
138138
<Property name="MAX_DEPTH_LIMIT">
139139

140-
The operation was not executed due to exceeding the max_depth limit.
140+
The operation was not executed due to exceeding the `max_depth` limit.
141141

142142
</Property>
143143
<Property name="MAX_HEIGHT_LIMIT">
144144

145-
The operation was not executed due to exceeding the max_height limit.
145+
The operation was not executed due to exceeding the `max_height` limit.
146146

147147
</Property>
148148
<Property name="MAX_ROOT_FIELDS_LIMIT">
149149

150-
The operation was not executed due to exceeding the max_root_fields limit.
150+
The operation was not executed due to exceeding the `max_root_fields` limit.
151151

152152
</Property>
153153
<Property name="QUERY_NOT_IN_SAFELIST">
@@ -169,7 +169,7 @@ There was an attempt to store this operation in the APQ cache, but the provided
169169
</Property>
170170
<Property name="PERSISTED_QUERY_NOT_FOUND">
171171

172-
The operation was not executed since it was not found in the automatic persisted query (APQ) cache.
172+
The operation was not executed because it was not found in the automatic persisted query (APQ) cache.
173173
This is an expected behavior when using the APQ protocol.
174174

175175
</Property>

0 commit comments

Comments
 (0)