Skip to content

Commit b4562fd

Browse files
committed
Add missing public functions and classes to the docs
1 parent c75f5de commit b4562fd

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

‎docs/modules/execution.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Execution
3232

3333
.. autoclass:: MiddlewareManager
3434

35+
.. autofunction:: get_argument_values
36+
3537
.. autofunction:: get_directive_values
3638

3739
.. autofunction:: get_variable_values

‎docs/modules/type.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Definition
1313
Predicates
1414
^^^^^^^^^^
1515

16+
.. autofunction:: is_abstract_type
1617
.. autofunction:: is_composite_type
1718
.. autofunction:: is_enum_type
1819
.. autofunction:: is_input_object_type
@@ -25,6 +26,8 @@ Predicates
2526
.. autofunction:: is_nullable_type
2627
.. autofunction:: is_object_type
2728
.. autofunction:: is_output_type
29+
.. autofunction:: is_required_argument
30+
.. autofunction:: is_required_input_field
2831
.. autofunction:: is_scalar_type
2932
.. autofunction:: is_type
3033
.. autofunction:: is_union_type
@@ -116,13 +119,20 @@ Predicates
116119
.. autofunction:: is_directive
117120
.. autofunction:: is_specified_directive
118121

122+
Assertions
123+
^^^^^^^^^^
124+
125+
.. autofunction:: assert_directive
126+
119127
Definitions
120128
^^^^^^^^^^^
121129

122130
.. autoclass:: GraphQLDirective
123131
.. autoclass:: GraphQLIncludeDirective
124132
.. autoclass:: GraphQLSkipDirective
125133
.. autoclass:: GraphQLDeprecatedDirective
134+
.. autoclass:: GraphQLSpecifiedByDirective
135+
.. autoclass:: GraphQLOneOfDirective
126136

127137
.. data:: specified_directives
128138

@@ -172,6 +182,10 @@ Definitions
172182
.. autoclass:: GraphQLInt
173183
.. autoclass:: GraphQLString
174184

185+
.. data:: specified_scalar_types
186+
187+
A mapping containing all scalar types from the GraphQL specification
188+
175189
.. data:: GRAPHQL_MAX_INT
176190

177191
Maximum possible Int value as per GraphQL Spec (32-bit signed integer)
@@ -189,6 +203,11 @@ Predicates
189203

190204
.. autofunction:: is_schema
191205

206+
Assertions
207+
^^^^^^^^^^
208+
209+
.. autofunction:: assert_schema
210+
192211
Definitions
193212
^^^^^^^^^^^
194213

‎docs/modules/validation.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ Rules
3333

3434
A tuple with all validation rules defined by the GraphQL specification
3535

36+
.. data:: recommended_rules
37+
38+
A tuple with validation rules that are not part of the GraphQL specification,
39+
but recommended to be used, like limiting the depth of introspection queries
40+
3641
**Spec Section: "Executable Definitions"**
3742

3843
.. autoclass:: ExecutableDefinitionsRule
@@ -151,3 +156,8 @@ Rules
151156
.. autoclass:: UniqueArgumentDefinitionNamesRule
152157
.. autoclass:: UniqueDirectiveNamesRule
153158
.. autoclass:: PossibleTypeExtensionsRule
159+
160+
**Custom validation rules (not part of the specification)**
161+
162+
.. autoclass:: NoDeprecatedCustomRule
163+
.. autoclass:: NoSchemaIntrospectionCustomRule

0 commit comments

Comments
 (0)