mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-23 01:56:54 +03:00
da1359ecca
* expose livehtml autobuild in Makefile * add API documentation for schema * document graphene core API * fixes black lint * Update graphene/types/union.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/argument.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/field.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/inputfield.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * add note about non-functional `interfaces` meta argument in mutation * update with other virtual environment configuration * pin autobuild * format argument example code * format enum input object and interface examples * format enum mutation union examples * revise documentation with imports, capitalization
107 lines
1.6 KiB
ReStructuredText
107 lines
1.6 KiB
ReStructuredText
API Reference
|
|
=============
|
|
|
|
Schema
|
|
------
|
|
|
|
.. autoclass:: graphene.types.schema.Schema
|
|
:members:
|
|
|
|
.. Uncomment sections / types as API documentation is fleshed out
|
|
.. in each class
|
|
|
|
Object types
|
|
------------
|
|
|
|
.. autoclass:: graphene.ObjectType
|
|
|
|
.. autoclass:: graphene.InputObjectType
|
|
|
|
.. autoclass:: graphene.Mutation
|
|
:members:
|
|
|
|
Fields (Mounted Types)
|
|
----------------------
|
|
|
|
.. autoclass:: graphene.Field
|
|
|
|
.. autoclass:: graphene.Argument
|
|
|
|
.. autoclass:: graphene.InputField
|
|
|
|
Fields (Unmounted Types)
|
|
------------------------
|
|
|
|
.. autoclass:: graphene.types.unmountedtype.UnmountedType
|
|
|
|
GraphQL Scalars
|
|
---------------
|
|
|
|
.. autoclass:: graphene.Int()
|
|
|
|
.. autoclass:: graphene.Float()
|
|
|
|
.. autoclass:: graphene.String()
|
|
|
|
.. autoclass:: graphene.Boolean()
|
|
|
|
.. autoclass:: graphene.ID()
|
|
|
|
Graphene Scalars
|
|
----------------
|
|
|
|
.. autoclass:: graphene.Date()
|
|
|
|
.. autoclass:: graphene.DateTime()
|
|
|
|
.. autoclass:: graphene.Time()
|
|
|
|
.. autoclass:: graphene.Decimal()
|
|
|
|
.. autoclass:: graphene.UUID()
|
|
|
|
.. autoclass:: graphene.JSONString()
|
|
|
|
Enum
|
|
----
|
|
|
|
.. autoclass:: graphene.Enum()
|
|
|
|
Structures
|
|
----------
|
|
|
|
.. autoclass:: graphene.List
|
|
|
|
.. autoclass:: graphene.NonNull
|
|
|
|
Type Extension
|
|
--------------
|
|
|
|
.. autoclass:: graphene.Interface()
|
|
|
|
.. autoclass:: graphene.Union()
|
|
|
|
Execution Metadata
|
|
------------------
|
|
|
|
.. autoclass:: graphene.ResolveInfo
|
|
|
|
.. autoclass:: graphene.Context
|
|
|
|
.. autoclass:: graphql.execution.base.ExecutionResult
|
|
|
|
.. Relay
|
|
.. -----
|
|
|
|
.. .. autoclass:: graphene.Node
|
|
|
|
.. .. autoclass:: graphene.GlobalID
|
|
|
|
.. .. autoclass:: graphene.ClientIDMutation
|
|
|
|
.. .. autoclass:: graphene.Connection
|
|
|
|
.. .. autoclass:: graphene.ConnectionField
|
|
|
|
.. .. autoclass:: graphene.PageInfo
|