Skip to content

Commit dade062

Browse files
authored
Add xml comments to IExecutionContext (graphql-dotnet#1598)
1 parent 112c872 commit dade062

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

src/GraphQL/Execution/IExecutionContext.cs

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,71 @@ namespace GraphQL.Execution
99
{
1010
public interface IExecutionContext : IProvideUserContext
1111
{
12+
/// <summary>
13+
/// Propagates notification that the GraphQL request should be canceled
14+
/// </summary>
1215
CancellationToken CancellationToken { get; }
1316

17+
/// <summary>
18+
/// The parsed GraphQL request
19+
/// </summary>
1420
Document Document { get; }
1521

22+
/// <summary>
23+
/// A list of errors generated during GraphQL request processing
24+
/// </summary>
1625
ExecutionErrors Errors { get; }
1726

27+
/// <summary>
28+
/// A list of <see cref="FragmentDefinition"/>s that pertain to the GraphQL request
29+
/// </summary>
1830
Fragments Fragments { get; }
1931

32+
/// <summary>
33+
/// A list of <see cref="IDocumentExecutionListener"/>s, enabling code to be executed at various points during the processing of the GraphQL query
34+
/// </summary>
2035
List<IDocumentExecutionListener> Listeners { get; }
2136

37+
/// <summary>
38+
/// If set, limits the maximum number of nodes (in other words GraphQL fields) executed in parallel
39+
/// </summary>
2240
int? MaxParallelExecutionCount { get; }
2341

42+
/// <summary>
43+
/// Provides performance metrics logging capabilities
44+
/// </summary>
2445
Metrics Metrics { get; }
2546

47+
/// <summary>
48+
/// The GraphQL operation that is being executed
49+
/// </summary>
2650
Operation Operation { get; }
2751

52+
/// <summary>
53+
/// Object to pass to the <see cref="IResolveFieldContext.Source"/> property of first-level resolvers
54+
/// </summary>
2855
object RootValue { get; }
2956

57+
/// <summary>
58+
/// Schema of the graph to use
59+
/// </summary>
3060
ISchema Schema { get; }
3161

62+
/// <summary>
63+
/// When <c>false</c>, <see cref="DocumentExecuter"/> and <see cref="ExecutionStrategy"/> capture unhandled
64+
/// exceptions and store them within <see cref="Errors">Errors</see>
65+
/// </summary>
3266
bool ThrowOnUnhandledException { get; }
3367

68+
/// <summary>
69+
/// A delegate that can override, hide, modify, or log unhandled exceptions before they are stored
70+
/// within <see cref="Errors"/> as an <see cref="ExecutionError"/>.
71+
/// </summary>
3472
Action<UnhandledExceptionContext> UnhandledExceptionDelegate { get; }
3573

74+
/// <summary>
75+
/// Input variables to the GraphQL request
76+
/// </summary>
3677
Variables Variables { get; }
3778
}
3879
}

0 commit comments

Comments
 (0)