Skip to content

doc:connection:precise expected return of connection resolver #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/relay/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,16 @@ Connection Field
You can create connection fields in any Connection, in case any ObjectType
that implements ``Node`` will have a default Connection.

The resolver of a connection field should return a list of objects of the
announced type. Those objects will automatically be wrapped in the edge and node
structure of the connection.

.. code:: python

class Faction(graphene.ObjectType):
name = graphene.String()
ships = relay.ConnectionField(ShipConnection)

def resolve_ships(self, info):
return []
# shall return a list of ship objects
return get_ship_list()