Skip to content

Commit 76f8a35

Browse files
committed
Add documentation for scalar type arguments
1 parent 92f6a49 commit 76f8a35

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/types/scalars.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
Scalars
22
=======
33

4+
All Scalar types accept the following arguments. All are optional:
5+
6+
``name``: *string*
7+
8+
Override the name of the Field.
9+
10+
``description``: *string*
11+
12+
A description of the type to show in the GraphiQL browser.
13+
14+
``required``: *boolean*
15+
16+
If ``True``, the server will enforce a value for this field. See `NonNull <./list-and-nonnull.html#nonnull>`_. Default is ``False``.
17+
18+
``deprecation_reason``: *string*
19+
20+
Provide a deprecation reason for the Field.
21+
22+
``default_value``: *any*
23+
24+
Provide a default value for the Field.
25+
26+
27+
28+
Base scalars
29+
------------
30+
431
Graphene defines the following base Scalar Types:
532

633
- ``graphene.String``

0 commit comments

Comments
 (0)