Skip to content

Commit 57a2c8e

Browse files
Copilotxperiandri
andcommitted
Add GraphQL spec section links to OperationError XML docs
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/aabfb966-da13-41e9-821e-b097aa211948 Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
1 parent 556e301 commit 57a2c8e

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

src/FSharp.Data.GraphQL.Client/BaseTypes.fs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,18 @@ type SchemaFieldInfo =
2626
/// A type alias to represent a Type name.
2727
type TypeName = string
2828

29-
/// Contains data about a GQL operation error.
29+
/// Contains source location information for a single GraphQL error location entry in the response.
30+
/// See GraphQL specification sections <see href="https://spec.graphql.org/October2021/#sec-Errors"/> and
31+
/// <see href="https://spec.graphql.org/October2021/#sec-Response-Format"/>.
3032
type OperationErrorLocation =
3133
{ /// The source line of the GraphQL operation document where the error occurred.
3234
Line : int
3335
/// The source column of the GraphQL operation document where the error occurred.
3436
Column : int }
3537

36-
/// Contains data about a GQL operation error.
38+
/// Contains data about a GraphQL operation error as defined by the GraphQL response format.
39+
/// See GraphQL specification sections <see href="https://spec.graphql.org/October2021/#sec-Errors"/> and
40+
/// <see href="https://spec.graphql.org/October2021/#sec-Response-Format"/>.
3741
type OperationError =
3842
{ /// The description of the error that happened in the operation.
3943
Message : string
@@ -475,7 +479,9 @@ type OperationResultBase (rawResponse: HttpResponseMessage, responseJson : JsonV
475479
[<CompilerMessageAttribute("This property is intended for use in generated code only.", 10001, IsHidden=true, IsError=false)>]
476480
member _.RawData = rawData
477481

478-
/// Gets all the errors returned by the operation on the server.
482+
/// Gets all GraphQL errors returned by the server.
483+
/// See GraphQL specification sections <see href="https://spec.graphql.org/October2021/#sec-Errors"/> and
484+
/// <see href="https://spec.graphql.org/October2021/#sec-Response-Format"/>.
479485
member _.Errors = errors
480486

481487
/// Gets all the custom data returned by the operation on server as a map of names and values.

0 commit comments

Comments
 (0)