Commit Graph

40 Commits

Author SHA1 Message Date
Luis Fernando
85dae9be9f
docs: add reference to QualifiedTable to table args (#3880) 2020-02-27 15:32:46 +05:30
Rikin Kachhia
048c1de414
docs: add actions docs (#3907) 2020-02-24 21:49:14 +05:30
Rikin Kachhia
0805719523
docs: remove wip actions docs (#3909)
* revert actions docs
2020-02-19 17:49:35 +05:30
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
Marion Schleifer
265cf7f12e docs: add meta descriptions to pages (#3631) 2020-01-14 18:27:45 +05:30
Rikin Kachhia
db6b2aa378
add computed fields support on console (close #3203 #3565) (#3522) 2020-01-13 12:41:30 +05:30
Aravind Shankar
756d8abd54 add rename_relationship metadata api docs (#3389) 2019-12-17 22:04:49 +05:30
Gordon Johnston
f03bbfd704 fix property name in metadata docs (#3419)
* Fix property name

The key for the 'relationship' property is 'relationship' and not 'name'. The example is correct but the syntax table was wrong.

* fix second table
2019-11-29 18:04:07 +05:30
Rakesh Emmadi
9b8e6b42d1 functions can access session info via input arg (close #2322) (#3143) 2019-11-20 12:17:06 +05:30
Tirumarai Selvan
2d5cdab60f add run_sql api read_only arg to docs (#3370) 2019-11-20 11:57:49 +05:30
Rakesh Emmadi
d8d21c1487 support computed fields returning scalars or set of tables (close #1387) (#2917) 2019-10-18 13:59:47 +05:30
Rakesh Emmadi
9bd5826020 allow customising graphql schema for a table (close #981) (#2509)
* allow customizing GraphQL root field names, close #981

* document v2 track_table API in reference

* support customising column field names in GraphQL schema

* [docs] add custom column fields doc in API reference

* add tests

* rename 'ColField' to 'ColumnField'

* embed column's graphql field in 'PGColumnInfo'

-> Value constructor of 'PGCol' is not exposed
-> Using 'parseJSON' to construct 'PGCol' in 'FromJSON' instances

* avoid using 'Maybe TableConfig'

* refactors & 'custom_column_fields' -> 'custom_column_names'

* cli-test: add configuration field in metadata export test

* update expected keys in `FromJSON` instance of `TableMeta`

* use `buildSchemaCacheFor` to update configuration in v2 track_table

* remove 'GraphQLName' type and use 'isValidName' exposed from parser lib

* point graphql-parser-hs library git repo to hasura

* support 'set_table_custom_fields' query API & added docs and tests
2019-09-19 10:17:36 +05:30
Kevin Barrett
b544f75a10 docs: swap manual_mapping for manual_configuration (close #2887) (#2888)
The docs specify `manual_mapping` for array relationship manual configs, and also mention the attribute in a note. However, using `manual_mapping` errors; `manual_configuration` is the correct attribute name.
2019-09-17 11:38:23 +05:30
Marion Schleifer
480b34ea5e fix typos in documentation (#2562) 2019-09-11 12:47:14 +05:30
Rakesh Emmadi
de1ab241f8 allow creating permissions with conditions spanning tables (close #2512) (#2701) 2019-09-05 13:04:53 +05:30
Rikin Kachhia
47fb329090
update enums docs (#2813) 2019-09-03 19:47:36 +05:30
Alexis King
c48904551e Document enum tables and enum table metadata APIs 2019-08-26 00:54:56 -05:00
Tirumarai Selvan
98784212e2 allow configuring timeout for remote schema calls (close #2501) (#2753) 2019-08-23 14:27:19 +05:30
Rikin Kachhia
e3f68dbb67
add support for column comparision operators in permissions builder (close #2040) (#2606) 2019-07-29 14:58:27 +05:30
Vamshi Surabhi
f1cf6d0b17
allow session variables in operators which expect array input (#2475) 2019-07-10 15:49:58 +05:30
Rakesh Emmadi
9eb38e6c96 cache remote schema's introspection query response (fix #1679) (#2089) 2019-07-08 11:21:41 +05:30
Rakesh Emmadi
eff952dc3a update run_sql metadata API documentation (#2350) 2019-06-11 14:44:19 +05:30
Rakesh Emmadi
0b210cc245 support allow-list for graphql queries (closes #989) (#2075) 2019-05-16 11:43:25 +05:30
Tirumarai Selvan
36e49ea75b manual event triggers (close #1687) (#2077) 2019-05-13 15:11:07 +05:30
Shahidh K Muhammed
71cf017197 add an api to dump postgres schema (close #1939) (#1967) 2019-04-30 14:04:08 +05:30
Rakesh Emmadi
1d7cbc7f24 recover from inconsistent database state (closes #231) (#1863) 2019-04-17 21:59:39 +05:30
Rikin Kachhia
afc2331951
update docs (#2023)
* add missing column error to troubleshooting
* update subscription headers section
* docs for using {} expression
* fix create foreign-key section
2019-04-17 19:07:42 +05:30
dsandip
d451b56d78 update permissions ref docs to include all config keys (#1918) 2019-04-01 14:28:39 +05:30
Shahidh K Muhammed
7bfcc764db update migration, api-reference docs (close #766) (close #1345) (close #1496) (#1701) 2019-03-28 16:21:58 +05:30
Rakesh Emmadi
7334c65087 update operators in metadata api docs (#1610) 2019-02-15 18:18:18 +05:30
nizar-m
f83a8e591f rename access-key to admin-secret (close #1347) (#1540)
Rename the admin secret key header used to access GraphQL engine from X-Hasura-Access-Key to X-Hasura-Admin-Secret.

Server CLI and console all support the older flag but marks it as deprecated.
2019-02-14 15:07:47 +05:30
Rikin Kachhia
e8e0168da7 docs update (#1535) 2019-02-06 12:09:36 +05:30
Rakesh Emmadi
0bf2457e23 allow exposing postgres functions through GraphQL interface (close #333) (#1073) 2019-01-25 09:01:54 +05:30
Rikin Kachhia
8de12d5bcd
add table of contents to docs pages (#1115) 2018-12-03 17:42:24 +05:30
Shahidh K Muhammed
ba7673af33
rename query to type on api reference 2018-10-29 14:42:44 +05:30
Vinayak
e830931294 fix grammatical errors in docs (#861) 2018-10-27 15:21:14 +05:30
Tirumarai Selvan
810b440089 trigger webhooks on column level changes instead of row (close #547, close #680) (#550) 2018-10-25 12:52:51 +05:30
Rakesh Emmadi
405f5edb34 document 'track_table' and 'untrack_table' query (close #715) (#777) 2018-10-17 10:57:11 +05:30
Burak Özdemir
feb8968879 fix e.g. and i.e. typos (#732) 2018-10-15 14:17:21 +05:30
Shahidh K Muhammed
1c15a9482a
add docs for schema / metadata api (close #409) (#626) 2018-10-08 19:42:03 +05:30