graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2024-09-22 03:49:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #69 from ustun/improve_object_argument_docs

Browse Source 
Add documentation about using custom input object types as arguments
This commit is contained in:
Syrus Akbary 2015-12-11 13:55:31 -08:00
commit 0daf6d8ec0
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/pages/docs/basic-types.md
View File

@ -82,3 +82,21 @@ graphene.Field(graphene.String(), to=graphene.String())
# Is equivalent to:
graphene.Field(graphene.String(), to=graphene.Argument(graphene.String()))
```
## Using custom object types as argument
To use a custom object type as an argument, you need to inherit `graphene.InputObjectType`, not `graphene.ObjectType`.
```python
class CustomArgumentObjectType(graphene.InputObjectType):
field1 = graphene.String()
field2 = graphene.String()
```
Then, when defining this in an argument, you need to wrap it in an `Argument` object.
```python
graphene.Field(graphene.String(), to=graphene.Argument(CustomArgumentObjectType))
```