Skip to content

Commit 79bd405

Browse files
committed
Update Connectors error codes for 2.11 release.
1 parent 74ca851 commit 79bd405

File tree

1 file changed

+92
-34
lines changed
  • docs/source/schema-design/federated-schemas/reference

1 file changed

+92
-34
lines changed

docs/source/schema-design/federated-schemas/reference/errors.mdx

Lines changed: 92 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,86 @@ A [circular reference](/graphos/schema-design/connectors/troubleshooting#circula
6262
<tr>
6363
<td>
6464

65+
##### `CONNECT_BATCH_AND_THIS`
66+
67+
Since v2.11.0<sup>\*\*</sup>
68+
69+
</td>
70+
<td>
71+
72+
Using both [`$batch`](/graphos/connectors/mapping/variables#batch) and [`$this`](/graphos/connectors/mapping/variables#this) in a mapping is not allowed.
73+
74+
</td>
75+
</tr>
76+
<tr>
77+
<td>
78+
79+
###### `CONNECTORS_BATCH_KEY_NOT_IN_SELECTION`
80+
81+
Since v2.11.0<sup>\*\*</sup>
82+
83+
</td>
84+
<td>
85+
86+
`$batch` key is not reflected in the output selection of connector.
87+
88+
</td>
89+
</tr>
90+
<tr>
91+
<td>
92+
93+
###### `CONNECTORS_CANNOT_RESOLVE_KEY`
94+
95+
Since v2.11.0<sup>\*\*</sup>
96+
97+
</td>
98+
<td>
99+
100+
A `@key` could not be resolved for the given combination of variables.
101+
102+
</td>
103+
</tr>
104+
<tr>
105+
<td>
106+
65107
###### `CONNECTORS_FIELD_WITH_ARGUMENTS`
66108

67109
Since v2.10.0<sup>\*\*</sup>
68110

69111
</td>
70112
<td>
71113

72-
A field resolved by a connector has arguments defined.
114+
A field resolved by a [connector](/graphos/connectors) has arguments defined.
115+
116+
</td>
117+
</tr>
118+
<tr>
119+
<td>
120+
121+
###### `CONNECTORS_NON_ROOT_BATCH_KEY`
122+
123+
Since v2.11.0<sup>\*\*</sup>
124+
125+
126+
</td>
127+
<td>
128+
129+
Connector `$batch` key cannot be derived from a non-root variable such as `$this` or `$context`.
130+
131+
</td>
132+
</tr>
133+
<tr>
134+
<td>
135+
136+
137+
###### `CONNECT_ON_ROOT`
138+
139+
Since v2.11.0<sup>\*\*</sup>
140+
141+
</td>
142+
<td>
143+
144+
`@connect` cannot be applied to a query, mutation, or subscription root type
73145

74146
</td>
75147
</tr>
@@ -83,7 +155,7 @@ Since v2.10.0<sup>\*\*</sup>
83155
</td>
84156
<td>
85157

86-
The schema includes fields that aren't resolved by a connector.
158+
The schema includes fields that aren't resolved by a [connector](/graphos/connectors).
87159

88160
</td>
89161
</tr>
@@ -97,7 +169,7 @@ Since v2.10.0<sup>\*\*</sup>
97169
</td>
98170
<td>
99171

100-
[Abstract types](/graphos/schema-design/connectors/limitations#abstract-schema-types-are-unsupported) are not allowed when using connectors.
172+
[Abstract types](/graphos/connectors/reference/limitations#abstract-schema-types-are-unsupported) are not allowed when using connectors.
101173

102174
</td>
103175
</tr>
@@ -111,7 +183,7 @@ Since v2.10.0<sup>\*\*</sup>
111183
</td>
112184
<td>
113185

114-
[Certain directives](/graphos/schema-design/connectors/limitations) are not allowed when using connectors.
186+
[Certain directives](/graphos/connectors/reference/limitations) are not allowed when using connectors.
115187

116188
</td>
117189
</tr>
@@ -199,7 +271,7 @@ Since v2.10.0<sup>\*\*</sup>
199271
</td>
200272
<td>
201273

202-
Indicates two connector sources with the same name were created.
274+
Indicates two connector [sources](/graphos/connectors/requests#sharing-configuration-with-source) with the same name were created.
203275

204276
</td>
205277
</tr>
@@ -242,7 +314,7 @@ Since v2.10.0<sup>\*\*</sup>
242314
</td>
243315
<td>
244316

245-
No `name` was provided when creating a connector source with `@source`.
317+
No `name` was provided when creating a connector source with [`@source`](/graphos/connectors/requests#sharing-configuration-with-source).
246318

247319
</td>
248320
</tr>
@@ -477,7 +549,7 @@ Replaces [`VALUE_TYPE_FIELD_TYPE_MISMATCH`](#value-type-field-type-mismatch).
477549
<tr>
478550
<td>
479551

480-
###### `GRAPHQL_ERROR`
552+
###### `GRAPH_QL_ERROR`
481553

482554
Since v2.10.0<sup>\*\*</sup>
483555

@@ -512,7 +584,7 @@ Since v2.10.0<sup>\*\*</sup>
512584
</td>
513585
<td>
514586

515-
Fields that return an object type must use a group selection mapping `{}`.
587+
Fields that return an object type must use a group selection mapping (i.e. `a { b }`).
516588

517589
</td>
518590
</tr>
@@ -568,7 +640,7 @@ Since v2.10.0<sup>\*\*</sup>
568640
</td>
569641
<td>
570642

571-
The `http.body` provided in `@connect` was not valid.
643+
The mapping for `http.body` provided in `@connect` was not valid. See [Mapping Language Reference](/graphos/connectors/mapping) for more information on writing mappings.
572644

573645
</td>
574646
</tr>
@@ -582,7 +654,7 @@ Since v2.10.0<sup>\*\*</sup>
582654
</td>
583655
<td>
584656

585-
A provided header in `@source` or `@connect` was not valid.
657+
A provided header in `@source` or `@connect` was not valid. See [Headers](/graphos/connectors/requests#headers) for more on connector request headers.
586658

587659
</td>
588660
</tr>
@@ -596,7 +668,7 @@ Since v2.10.0<sup>\*\*</sup>
596668
</td>
597669
<td>
598670

599-
The provided selection mapping in a `@connect`s `selection` was not valid.
671+
The provided selection mapping in a `@connect`s `selection` was not valid. See [Mapping Language Reference](/graphos/connectors/mapping) for more information on writing selection mappings.
600672

601673
</td>
602674
</tr>
@@ -610,7 +682,7 @@ Since v2.10.0<sup>\*\*</sup>
610682
</td>
611683
<td>
612684

613-
The `name` provided for a `@source` was invalid. Source names must start with a letter, include only letters, numbers, underscores (`_`) and hyphens (`-`), and be less than 64 characters.
685+
The `name` provided for a [`@source`](/graphos/connectors/requests#sharing-configuration-with-source) was invalid. Source names must start with a letter, include only letters, numbers, underscores (`_`) and hyphens (`-`), and be less than 64 characters.
614686

615687
</td>
616688
</tr>
@@ -918,7 +990,7 @@ Since v2.10.0<sup>\*\*</sup>
918990
</td>
919991
<td>
920992

921-
A `@key` was defined without a corresponding entity connector.
993+
A `@key` was defined without a corresponding entity connector. See: [Working with Entities](/graphos/connectors/responses/entities) for more information.
922994

923995
</td>
924996
</tr>
@@ -932,7 +1004,7 @@ Since v2.10.0<sup>\*\*</sup>
9321004
</td>
9331005
<td>
9341006

935-
The `@connect` directive is missing an HTTP method.
1007+
The `@connect` directive is missing an [HTTP method](/graphos/connectors/requests#http-methods).
9361008

9371009
</td>
9381010
</tr>
@@ -946,7 +1018,7 @@ Since v2.10.0<sup>\*\*</sup>
9461018
</td>
9471019
<td>
9481020

949-
The `@connect` directive has multiple HTTP methods when only one is allowed.
1021+
The `@connect` directive has multiple [HTTP methods](/graphos/connectors/requests#http-methods) when only one is allowed.
9501022

9511023
</td>
9521024
</tr>
@@ -1009,20 +1081,6 @@ This is a specialization of [`SOURCE_NAME_MISMATCH`](#source_name_mismatch) erro
10091081
<tr>
10101082
<td>
10111083

1012-
###### `NULLABILITY_MISMATCH`
1013-
1014-
Since v2.10.0<sup>\*\*</sup>
1015-
1016-
</td>
1017-
<td>
1018-
1019-
A variable is nullable in a location which requires non-null at runtime.
1020-
1021-
</td>
1022-
</tr>
1023-
<tr>
1024-
<td>
1025-
10261084
###### `ONLY_INACCESSIBLE_CHILDREN`
10271085

10281086
Since v2.0.0
@@ -1464,7 +1522,7 @@ Since v2.10.0<sup>\*\*</sup>
14641522
</td>
14651523
<td>
14661524

1467-
The `source` argument used in a `@connect` directive doesn't match any named connecter sources created with `@source`.
1525+
The `source` argument used in a `@connect` directive doesn't match any named connector sources created with [`@source`](/graphos/connectors/requests#sharing-configuration-with-source).
14681526

14691527
</td>
14701528
</tr>
@@ -1478,7 +1536,7 @@ Since v2.10.0<sup>\*\*</sup>
14781536
</td>
14791537
<td>
14801538

1481-
Connectors currently [don't support subscription operations](/graphos/schema-design/connectors/limitations#subscriptions-are-unsupported).
1539+
Connectors currently [don't support subscription operations](/graphos/connectors/reference/limitations#subscriptions-are-unsupported).
14821540

14831541
</td>
14841542
</tr>
@@ -1536,7 +1594,7 @@ Since v2.10.0<sup>\*\*</sup>
15361594
</td>
15371595
<td>
15381596

1539-
Part of the `@connect` refers to an `$args` which is not defined.
1597+
Part of the `@connect` directive refers to an [`$args`](/graphos/connectors/mapping/variables#args) which is not defined.
15401598

15411599
</td>
15421600
</tr>
@@ -1550,7 +1608,7 @@ Since v2.10.0<sup>\*\*</sup>
15501608
</td>
15511609
<td>
15521610

1553-
Part of the `@connect` refers to an `$this` which is not defined.
1611+
Part of the `@connect` directive refers to an [`$this`](/graphos/connectors/mapping/variables#this) which is not defined.
15541612

15551613
</td>
15561614
</tr>
@@ -1634,7 +1692,7 @@ Since v2.10.0<sup>\*\*</sup>
16341692
</td>
16351693
<td>
16361694

1637-
A type used in a connector's variable is [not yet supported](/graphos/schema-design/connectors/limitations) (i.e., unions).
1695+
A type used in a connector's variable is [not yet supported](/graphos/connectors/reference/limitations) (i.e., unions).
16381696

16391697
</td>
16401698
</tr>

0 commit comments

Comments
 (0)