graphql-python/graphene-django
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene-django.git synced 2024-11-28 20:43:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
882 Commits 5 Branches 53 Tags 4.3 MiB
bb03306075
Commit Graph

153 Commits

Author SHA1 Message Date
Gert Van Gool
d5e71bc9be Fix typo of imoprt to import (#742) 2019-08-10 21:30:17 +01:00
Jonathan Kim
b7e4937775
Alias only_fields as fields and exclude_fields as exclude (#691) 
* Create new fields and exclude options that are aliased to exclude_fields and only_fields

* Update docs

* Add some checking around fields and exclude definitions

* Add all fields option

* Update docs to include `__all__` option

* Actual order of fields is not stable

* Update docs/queries.rst

Co-Authored-By: Semyon Pupkov <semen.pupkov@gmail.com>

* Fix example code

* Format code

* Start raising PendingDeprecationWarnings for using only_fields and exclude_fields

* Update tests
 2019-07-09 14:03:11 +01:00
Jonathan Kim
0988e0798a
Adds documentation to CAMELCASE_ERRORS setting (#689) 
* Rename setting and add documentation

* Add examples

* Use `cls`
 2019-07-08 22:22:08 +01:00
Jonathan Kim
612ba5a4ea
Add convert_choices_to_enum option on DjangoObjectType Meta class (#674) 
* Add convert_choices_to_enum meta option

* Add tests

* Run black

* Update documentation

* Add link to Django choices documentation

* Add test and documentation note

That setting to an empty list is the same as setting the value as False

* Fix Django warning in tests

* rst is not markdown
 2019-06-17 18:48:29 +01:00
Jonathan Kim
6e8dce95ae
Update doc setup (#673) 
* Expose doc commands in root makefile and add autobuild

* Fix some errors

* Alias some commands and add PHONY
 2019-06-14 12:33:37 +01:00
Emil Goldsmith Olesen
fcc491fffb Add watch option to graphql_schema (#656) 
* Add watch option to graphql_schema

* add documentation for grapql_schema --watch
 2019-06-09 17:06:50 -07:00
Mel van Londen
a9a8d672e9
Merge pull request #600 from sierreis/filterset-class 
Add support for filterset_class meta parameter
 2019-06-09 16:48:46 -07:00
Richard Sween
d06217d203
Fix Mutations Relay example imports 
Per comment here: https://github.com/graphql-python/graphene-django/pull/657#issuecomment-499618785
 2019-06-06 13:53:16 -05:00
Richard Sween
fc49a50cc3
Update mutations.rst 
I believe the `[1]` was ommitted from the `from_global_id` call as that method returns a tuple of type and id, of which we're only interested in the id here. Took me half a day to figure out why this code wasn't working today. See function def here: https://github.com/graphql-python/graphql-relay-py/blob/master/graphql_relay/node/node.py#L67
 2019-06-05 19:43:51 -05:00
Dulmandakh
49aedf171a bump graphiql to 0.13.0, and rename __debug to _debug due to __ limitations 2019-05-20 17:48:28 +08:00
Paul Hallett
80125c3077
Merge pull request #641 from changeling/fix_babel_link 
Correct Babel Relay Plugin docs link per Issue 358.
 2019-05-16 09:08:31 +01:00
changeling
04fe299a6e Corrected docs/queries.rst. (#633) 
* Corrected typos in docs/queries.rst.

* Add basic resolvers to Relay Full example in docs/queries.rst.

Added basic resolvers to Full example in Relay section.

* Remove question and question resolver.

* Add query example to queries.rst.

Added query example in Relay section.
Minor clean-up.
 2019-05-15 20:50:55 -04:00
changeling
884c4cce0c Correct Babel Relay Plugin docs link per Issue 358. 
See graphql-python#358.
 2019-05-15 16:27:35 -05:00
Paul Hallett
e26a9f2a44
Merge pull request #631 from graphql-python/fix-628 
Fix importing error for GraphQLTestCase
 2019-05-13 18:12:22 +01:00
David Beitey
ce9d989bcd Update install docs for Django 2.x 
This uses the new URL routing syntax introduced in Django 2.0 (https://docs.djangoproject.com/en/2.2/releases/2.0/#simplified-url-routing-syntax).  The older `url()` syntax will deprecated at some point in future https://docs.djangoproject.com/en/2.2/ref/urls/#url
 2019-05-13 17:08:26 +10:00
Paul Hallett
2bf7e7f66d
Fix importing error for GraphQLTestCase 2019-05-08 22:45:28 +01:00
Paul Hallett
bd53940d23
newline 2019-05-07 20:23:26 +01:00
Paul Hallett
df4a07982f
Add documentation for settings 2019-05-07 20:23:10 +01:00
Paul Hallett
31468f5687
Rebuild documentation 2019-05-07 19:23:01 +01:00
Mel van Londen
2016011394
Merge pull request #605 from GitRon/bugfix/missing-type-declaration-in-docs 
Missing LOC in django model form documentation (fixes #602)
 2019-04-27 09:34:58 -07:00
Mel van Londen
fb8a129752
Merge pull request #608 from GitRon/feature/base-test-class 
Added test class for django api unittests and documentation
 2019-04-27 09:16:23 -07:00
Edi Santoso
090ce6e1f1 Fix invalid url django-filter docs (#589) 2019-03-31 12:13:07 +01:00
Jason Kraus
0a5020bee1 Get queryset (#528) 
* first attempt at adding get_queryset

* add queryset_resolver to DjangoConnectionField and fix test failures

* cleanup get_queryset API to match proposal as close as possible

* pep8 fix: W293

* document get_queryset usage

* add test for when get_queryset is defined on DjangoObjectType
 2019-03-31 12:01:17 +01:00
Gary Donovan
fcc3de2a90 Allow graphql schema export to use a canonical representation (#439) 
When we use the `graphql_schema` management command, the output can vary from run to run depending on arbitrary factors (because there is no guarantee made about the order used to output JSON dictionary keys). This makes it difficult to compare two schema's at different points in time.

We address this by including a new `canonical` flag to the command, which uses standard `json.dump` funcitonality to sort dictionary keys and force pretty-printed output.
 2019-03-31 11:30:29 +01:00
Ronny Vedrilla
b491878c27 * Added test class for django api unittests and documentation how to use it 2019-03-29 11:51:40 +01:00
Ronny Vedrilla
547a4cb576 Missing LOC in django model form documentation (fixes #602) 2019-03-27 16:30:35 +01:00
sierreis
5c191b9062 Add support for filterset_class meta parameter 
* Allow for use of either filter_fields or filterset_class
* Add tests to check that the behavior is similar to filter_fields
* Add documentation to show how to make use of the parameter
 2019-03-25 00:38:49 -04:00
Atul Varma
263c7267cb Fix code errors in form-mutations.rst (#499) 
This fixes what appear to be some code errors/typos:

* The `FormMutation` class was renamed to `DjangoFormMutation`, and `ModelFormMutation` to `DjangoModelFormMutation`, in 40610c64a3.
* `form_valid` was renamed to `perform_mutate` in 463ce68b16.

It also clarifies a few things that I found confusing:

* It explicitly mentions that `perform_mutate` is a class method.
* The code samples now import the form classes from their packages, so readers know where to import them from too.
 2019-03-19 20:24:24 +00:00
Liam O'Flynn
75bf398523 Ensure code example is fully functional (#477) 
Simple change, it took me a while to figure out why the documentation's code was throwing an AssertionError :)
 2019-03-19 20:22:04 +00:00
Charles Bradshaw
ae126a6dc3 Add Introspection Schema Link in Documentation (#489) 
By the end of the Graphene and Django Tutorial using Relay, one might think they have finished everything needed server side for Relay, but six sections later, in a section that doesn't mention Relay in the title, the final required step for Relay is documented.
 2019-03-19 20:20:26 +00:00
Alonso
f3144bf996
fix order in params 2018-09-26 13:07:50 -05:00
Syrus Akbary
f6dba3942c
Merge pull request #506 from ccsv/patch-1 
Update authorization docs to Graphene 2.0
 2018-09-05 13:30:40 +02:00
Syrus Akbary
2ccd483ffc
Update authorization.rst 2018-09-05 13:22:54 +02:00
Syrus Akbary
446013c752
Update authorization.rst 2018-09-05 13:21:39 +02:00
Jay Hale
dc0c2900d1 Making GrapheneFilterSetMixin compatible with django_filter 2 2018-09-04 13:15:04 -04:00
C Chan
84d82f82a9
Update authorization docs to Graphene 2.0 
*  Re-write some language in "Limiting Field Access"
* Added code to "Queryset Filtering On Lists" section to handle queries that return nothing
* fix code to Filtering ID-based node access to work based on question [here](https://stackoverflow.com/questions/51057784/django-graphene-with-relay-restricting-queries-access-based-on-id/51958088#51958088)
* Rewrote Adding Login Requirements to be Django 2.0 compatible 
Fixed login requirements
 2018-08-29 00:37:27 -07:00
Adam
40da74fc52
Mention filter incompatibility with django 2.0 
Was in the process of updating our app to Python 3 + Django 2.1 and ran into this (would've been nice if t was mentioned in the docs).

Related: https://github.com/graphql-python/graphene-django/issues/464
 2018-08-07 11:04:52 -04:00
Adam Johnson
1ba9652f38
Reword 'abstract' -> 'mixin' in plain tutorial 
More technically correct
 2018-08-01 12:51:46 +01:00
Ramon Saraiva
1c4182fd5d Pin django-filter in filtering docs until full compatibility with 2.0.0 2018-07-17 02:19:35 -03:00
Eric L Frederich
3e3584565f Fix moved link 2018-06-13 17:02:45 -04:00
Syrus Akbary
9840a64dc9
Merge branch 'master' into master 2018-06-05 14:48:53 -07:00
Syrus Akbary
701611c246
Moved the admin plug down to the proper section 2018-06-05 14:48:06 -07:00
Syrus Akbary
f0451476ad
Merge pull request #422 from tadeo/master 
Fix doc: Bad documented SerializerMutation attribute
 2018-06-05 14:41:58 -07:00
Syrus Akbary
be22f1639b Updated docs 2018-06-05 14:20:21 -07:00
Syrus Akbary
a9e5beb9eb Merge branch 'master' into form_mutations 
# Conflicts:
#	graphene_django/forms/converter.py
#	graphene_django/forms/tests/test_converter.py
 2018-06-05 13:23:39 -07:00
Tadeo Carrier
b1245fed16 Fix doc: Bad documented SerializerMutation attribute 2018-04-05 14:46:10 -03:00
Syrus Akbary
a480a39713
Merge pull request #326 from pizzapanther/drf-serializer-update 
DRF Serializer update
 2018-03-29 23:22:14 -07:00
Syrus Akbary
9cdd95c114
Removed deprecated AbstractType from tutorial 2018-03-21 21:35:49 -07:00
Syrus Akbary
8151fe75b8
Merge pull request #406 from gabriel-sevecek/master 
Fix context-dependent filtering example in docs
 2018-03-14 23:28:07 -07:00
Syrus Akbary
e9a40f2ae9
Merge pull request #403 from eyal0803/patch-2 
Update authorization.rst
 2018-03-14 23:27:43 -07:00
Syrus Akbary
134d6c6d32
Updated docs template 2018-03-13 22:38:17 -07:00
Gabriel Sevecek
bc713f22cb
Update filtering.rst 2018-02-27 11:29:34 +01:00
eyal0803
d98d2a6a73
Update authorization.rst 
Someone probably forgot to change `CategoryNode`, from the previous tutorial, to `PostNode`.
 2018-02-23 20:59:19 +02:00
Paul Bailey
91a99ee39c serializer update support 2018-02-06 13:37:28 -06:00
Martijn Faassen
ea4ddc7f79
Adjustments to make it work with Django 2.0.1 
I tried the tutorial but ran into these two problems in Django 2.0.1.
 2018-01-18 16:46:08 +01:00
Stefan Stammberger
443b5eaafc
Docs: Update Cookbook tutorial 2017-12-02 19:35:17 +01:00
Kees Kluskens
70a6c72751
Docs: fix usage of deprecated AbstractType 
A tutorial still used `graphene.AbstractType` instead of `object`, which leads to a [deprecation warning](https://github.com/graphql-python/graphene/blob/master/UPGRADE-v2.0.md#abstracttype-deprecated).
 2017-11-18 22:10:39 +01:00
Syrus Akbary
bc59d0ad8e
Merge pull request #232 from basilfx/master 
Pass context object to FilterSet for request-baed filtering
 2017-11-13 02:39:18 -08:00
Syrus Akbary
ec2cea1afa
Merge pull request #311 from tervay/typo-fixes 
Fix documentation typos
 2017-11-12 10:26:16 -08:00
Justin Tervay
bbcd69967c
Fix typos 2017-11-01 13:56:28 -07:00
Vincent Poulailleau
00b5a176d3
typo in authorization.rst 
fix a small typo error in the documentation
 2017-10-30 09:54:09 +01:00
Syrus Akbary
77f036157b Merge pull request #279 from nikolas/patch-1 
intro tutorial: setup -> set up
 2017-10-09 13:21:34 +02:00
Dan Lousqui
9c9cef4ea9 Update authorization.rst 
Upgrading doc, as suggested in https://github.com/graphql-python/graphene-django/issues/282
 2017-10-08 14:42:34 +02:00
Nik Nyby
04fc5a0305 intro tutorial: setup -> set up 
"setup" is a noun, while "set up" is a verb. I've updated the usage here.
 2017-10-04 23:13:00 -04:00
Grant McConnaughey
f5083cb190 Change form valid method names 2017-10-02 09:32:36 -05:00
Grant McConnaughey
507246468b Document form mutations 2017-10-02 09:32:36 -05:00
Jeremy Spencer
84d063261e Updated tutorial-plain to be in line with breaking changes in graphen-python>=2.0.dev: https://github.com/graphql-python/graphene/blob/master/UPGRADE-v2.0.md\#simpler-resolvers 2017-09-04 08:04:10 -04:00
Syrus Akbary
9cac83b168 Merge pull request #243 from jonatasbaldin/jonatas/fix-filtering-documentation 
Fix lookup parameter on filtering documentation
 2017-08-29 22:33:35 -07:00
Haris Ibrahim K. V
bf2b5a940e Changes one more occurence of the django-filter link. 2017-08-15 14:32:59 +05:30
Haris Ibrahim K. V
b9c8bb57be Fixes the link to django-filter usage documentation. 2017-08-15 14:09:36 +05:30
Jonatas Baldin
dead04da77 Correct lookup parameter on django-filter is lookup_expr 2017-08-12 23:24:50 -03:00
Bas Stottelaar
4bdcf054eb Pass context object to FilterSet instance to support request-baed filtering (fixes #203). 2017-07-28 16:46:39 +02:00
Syrus Akbary
cec1a84480 Merge pull request #216 from Txumari/patch-1 
Fix install ingredients app
 2017-07-23 21:15:59 -07:00
Jesus Mª
e425758f5b Fix install ingredients app 
You need the app installed for the migrations
 2017-07-17 23:51:21 +02:00
Patrick Arminio
60b6ba82ba Initial docs 2017-06-26 09:19:49 +01:00
Bryan Kimani
caa6eecc7a Update tutorial-plain.rst 
If your run ``$ python ./manage.py loaddata ingredients`` without installing ``ingredients`` app in the project ``settings.py`` you will get the following error ``CommandError: No fixture named 'ingredients' found``. So make sure ``ingredients`` app has been put on the ``settings.py`` INSTALLED_APPS section before running ``$ python ./manage.py loaddata ingredients``.
 2017-05-01 21:08:38 +03:00
Syrus Akbary
488992b047 Merge branch 'add-introduction-tutorial' of https://github.com/RadoRado/graphene-django 2017-02-21 20:59:06 -08:00
Radoslav Georgiev
5d7794815f Fix GraphiQL URL which is configured in the tutorial. 
- Based on <e063ef3cfc>
 2017-02-21 21:39:25 +02:00
Radoslav Georgiev
f15d2f6762 Update tutorial-relay.rst structure to match plain 2017-02-21 21:32:45 +02:00
Radoslav Georgiev
0b4db6a42d Improve summary section 
- Mention automatic pagination
 2017-02-21 21:15:43 +02:00
Radoslav Georgiev
9621054852 Add reference to cookbook-plain in tutorial-plain.rst 2017-02-14 20:28:49 +02:00
Radoslav Georgiev
b55e988205 Add Summary section with some paragraphs 2017-02-14 19:55:38 +02:00
Craig Anderson
e063ef3cfc Fix GraphiQL URL which is configured in the tutorial. 2017-02-14 17:37:46 +00:00
Craig Anderson
99e2339877 Correct imports in tutorial 2017-02-14 17:31:23 +00:00
Radoslav Georgiev
950cab641b Bump year to 2017 2017-02-12 16:48:59 +02:00
Radoslav Georgiev
1304183893 Spellcheck tutorial-plain.rst 2017-02-12 16:48:48 +02:00
Radoslav Georgiev
61dd8c4277 Add basic structure for plain tutorial 
- `tutorial.rst` is now `tutorial-relay.rst`
- Added `tutorial-plain.rst`
 2017-02-12 16:44:39 +02:00
Syrus Akbary
f3d9cbcd14 Merge pull request #109 from BossGrand/master 
Added documentations for limiting field access using exclude_fields...
 2017-02-11 16:14:34 -08:00
Radoslav Georgiev
b63cb772e4 Add Adding login required section to authorization 2017-02-09 18:18:50 +02:00
BossGrand
84a074250b missed a period 2017-02-06 17:00:35 -08:00
BossGrand
602e1f9de1 Added documentation for exclude_fields 
as a method of limiting field access

DjangoObjectType
 2017-02-06 16:59:13 -08:00
Thierry Guillemot
3f139da7ae Fix Post name attribute 
The `PostNode` class uses as model Post which does not have any field `title`
 2016-12-05 11:01:49 +01:00
Thierry Guillemot
85da376333 Fix the setup of the cookbook example 
`ingredients` and `recipes` from [examples/cookbook](https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook) are included in cookbook/cookbook. 
By following the tutorial `ingredients` and `recipes` are in `cookbook/`.

Two possibilities : 
1) There is a mistake in the doc and I can correct it by adding a `cd cookbook` (as done by the PR)
2) Correct the [examples/cookbook](https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook).

Solution 1 is easier but  I prefer the solution 2 because it is closer of what is done in the [django tutorial](https://docs.djangoproject.com/en/1.10/intro/tutorial01/).
 2016-12-05 10:59:06 +01:00
Syrus Akbary
9d35b76697 Remove order_by in docs 2016-11-23 02:32:52 -08:00
Syrus Akbary
1e7c7ac34f Merge pull request #55 from dukebody/docs-build-instructions 
Add docs about how to build docs, and add sphinx as docs requirement.
 2016-11-13 19:21:02 -08:00
Israel Saeta Pérez
e72f6b2610 Explain alternative way to specify schema in tutorial. 2016-11-12 20:08:01 +01:00
Israel Saeta Pérez
d84c651bb4 Add docs about how to build docs, and add sphinx as docs requirement. 2016-11-12 19:47:44 +01:00
Aleck Landgraf
c25e2c6d25 Fixes typo in docs 2016-10-18 14:30:15 -07:00
Joe Larson
d1f2863374 fixes docs to include ObjectType in root query 2016-10-03 13:23:22 -06:00
Syrus Akbary
2f9c5ee707 Updated docs as graphql highlight is not yet supported 2016-09-26 01:13:31 -07:00