graphql-engine/docs
Vamshi Surabhi b84db36ebb
allow custom mutations through actions (#3042)
* basic doc for actions

* custom_types, sync and async actions

* switch to graphql-parser-hs on github

* update docs

* metadata import/export

* webhook calls are now supported

* relationships in sync actions

* initialise.sql is now in sync with the migration file

* fix metadata tests

* allow specifying arguments of actions

* fix blacklist check on check_build_worthiness job

* track custom_types and actions related tables

* handlers are now triggered on async actions

* default to pgjson unless a field is involved in relationships, for generating definition list

* use 'true' for action filter for non admin role

* fix create_action_permission sql query

* drop permissions when dropping an action

* add a hdb_role view (and relationships) to fetch all roles in the system

* rename 'webhook' key in action definition to 'handler'

* allow templating actions wehook URLs with env vars

* add 'update_action' /v1/query type

* allow forwarding client headers by setting `forward_client_headers` in action definition

* add 'headers' configuration in action definition

* handle webhook error response based on status codes

* support array relationships for custom types

* implement single row mutation, see https://github.com/hasura/graphql-engine/issues/3731

* single row mutation: rename 'pk_columns' -> 'columns' and no-op refactor

* use top level primary key inputs for delete_by_pk & account select permissions for single row mutations

* use only REST semantics to resolve the webhook response

* use 'pk_columns' instead of 'columns' for update_by_pk input

* add python basic tests for single row mutations

* add action context (name) in webhook payload

* Async action response is accessible for non admin roles only if
  the request session vars equals to action's

* clean nulls, empty arrays for actions, custom types in export metadata

* async action mutation returns only the UUID of the action

* unit tests for URL template parser

* Basic sync actions python tests

* fix output in async query & add async tests

* add admin secret header in async actions python test

* document async action architecture in Resolve/Action.hs file

* support actions returning array of objects

* tests for list type response actions

* update docs with actions and custom types metadata API reference

* update actions python tests as per #f8e1330

Co-authored-by: Tirumarai Selvan <tirumarai.selvan@gmail.com>
Co-authored-by: Aravind Shankar <face11301@gmail.com>
Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com>
2020-02-13 23:08:23 +05:30
..
_ext docs: cli related and syntax fix (#1463) 2019-01-24 19:46:34 +05:30
_static docs: fix color of paragraph anchor (#3629) 2020-01-03 17:22:28 +05:30
_theme/djangodocs docs: add canonical url, fix accessibility (#3599) 2019-12-30 14:32:06 +05:30
algolia_index pep8 fixes for python files (#875) 2018-10-30 14:51:58 +05:30
examples_schema_migrations merge docs into main repo (close #397) (#398) 2018-09-11 16:41:24 +05:30
graphql/manual allow custom mutations through actions (#3042) 2020-02-13 23:08:23 +05:30
img add computed fields support on console (close #3203 #3565) (#3522) 2020-01-13 12:41:30 +05:30
.gitignore add guide for subscriptions using apollo-client (fix #444) (#1018) 2018-12-07 16:48:05 +05:30
404.rst merge docs into main repo (close #397) (#398) 2018-09-11 16:41:24 +05:30
conf.py refactor schema management in console and misc fixes (#2016) 2019-05-24 19:30:44 +05:30
CONTRIBUTING.md fix typos in documentation (#2562) 2019-09-11 12:47:14 +05:30
index.rst fix typos in documentation (#2562) 2019-09-11 12:47:14 +05:30
Makefile add an api to dump postgres schema (close #1939) (#1967) 2019-04-30 14:04:08 +05:30
README.md fix typos in documentation (#2562) 2019-09-11 12:47:14 +05:30
requirements.txt fix docs dependency vulnerability (#2048) 2019-04-23 13:54:48 +05:30

Hasura GraphQL Engine Docs

The documentation accompanying the Hasura GraphQL engine is written with Sphinx and deployed to docs.hasura.io.

Contributing

Check out the contributing guide for more details.

License

The source code in this directory are under MIT License.