From 21850182554efa5aacb244926b783ec48fba3fc3 Mon Sep 17 00:00:00 2001 From: Marion Schleifer Date: Wed, 24 Jun 2020 09:01:31 +0200 Subject: [PATCH] docs: add note on permissions to certain mutations (close #5058) (#5135) --- docs/graphql/manual/mutations/delete.rst | 6 +++++- docs/graphql/manual/mutations/insert.rst | 4 ++++ docs/graphql/manual/mutations/update.rst | 4 ++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/graphql/manual/mutations/delete.rst b/docs/graphql/manual/mutations/delete.rst index 35e43a5559a..5bee12a5149 100644 --- a/docs/graphql/manual/mutations/delete.rst +++ b/docs/graphql/manual/mutations/delete.rst @@ -105,6 +105,10 @@ row object or ``null`` if the row does not exist. } } +.. note:: + + ``delete__by_pk`` will **only** be available if you have select permissions on the table, as it returns the deleted row. + .. admonition:: Supported from The ``delete_
_by_pk`` mutation is supported in versions ``v1.2.0`` @@ -183,4 +187,4 @@ evaluates to ``true`` for all objects. "affected_rows": 20 } } - } \ No newline at end of file + } diff --git a/docs/graphql/manual/mutations/insert.rst b/docs/graphql/manual/mutations/insert.rst index 48123056410..e3e74fda5f4 100644 --- a/docs/graphql/manual/mutations/insert.rst +++ b/docs/graphql/manual/mutations/insert.rst @@ -110,6 +110,10 @@ Using variables: } } +.. note:: + + ``insert__one`` will **only** be available if you have select permissions on the table, as it returns the inserted row. + .. admonition:: Supported from The ``insert__one`` mutation is supported in versions ``v1.2.0`` diff --git a/docs/graphql/manual/mutations/update.rst b/docs/graphql/manual/mutations/update.rst index 17019c4cd3a..121fe453125 100644 --- a/docs/graphql/manual/mutations/update.rst +++ b/docs/graphql/manual/mutations/update.rst @@ -110,6 +110,10 @@ row object or ``null`` if the row does not exist. } } +.. note:: + + ``update_
_by_pk`` will **only** be available if you have select permissions on the table, as it returns the updated row. + .. admonition:: Supported from The ``update_
_by_pk`` mutation is supported in versions ``v1.2.0``