graphql-engine/docs
Swann Moreau 8bd34b4a51 server, pro: add support for per-role allowlists
spec: https://github.com/hasura/graphql-engine-mono/pull/2278

Briefly:
- extend metadata so that allowlist entries get a new scope field
- update `add_collection_to_allowlist` to accept this new scope field,
  and adds `update_scope_of_collection_in_allowlist` to change the scope
- scope can be global or role-based; a collection is available for every
  role if it is global, and available to every listed role if it is role-based
- graphql-engine-oss is aware of role-based allowlist metadata; collections
  with non-global scope are treated as if they weren't in the allowlist

To run the tests:
- `cabal run graphql-engine-tests -- unit --match Allowlist`
- py-tests against pro:
  - launch `graphql-engine-pro` with `HASURA_GRAPHQL_ADMIN_SECRET` and `HASURA_GRAPHQL_ENABLE_ALLOWLIST`
  - `pytest test_allowlist_queries.py --hge-urls=... --pg-urls=... --hge-key=... --test-allowlist-queries --pro-tests`

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/2477
Co-authored-by: Anon Ray <616387+ecthiender@users.noreply.github.com>
Co-authored-by: Robert <132113+robx@users.noreply.github.com>
GitOrigin-RevId: 01f8026fbe59d8701e2de30986511a452fce1a99
2022-02-08 16:54:49 +00:00
..
_ext docs: update to latest urls in sitemap (#651) 2021-02-23 18:57:27 +00:00
_static docs: segment track event naming adjustment 2021-12-01 09:07:53 +00:00
_theme/djangodocs docs: header links updated 2021-12-02 20:25:49 +00:00
algolia_index pep8 fixes for python files (#875) 2018-10-30 14:51:58 +05:30
graphql server, pro: add support for per-role allowlists 2022-02-08 16:54:49 +00:00
img docs: Docs for email change on Hasura Cloud 2022-02-07 06:05:48 +00:00
.gitignore server: support restified versions of graphql queries (#303) 2021-01-29 01:03:35 +00:00
.python-version docs: console / cli / api workflows (close #3593) (#4948) 2020-10-13 11:07:46 +00:00
404.rst docs: move cloud docs (#5411) 2020-08-25 17:23:25 +05:30
conf.py docs: Segment Analytics Implementation 2021-09-30 12:24:56 +00:00
CONTRIBUTING.md Fix case of GitHub 2020-11-17 19:29:41 +05:30
index.rst docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
Makefile docs: fix sitemap generation (#5490) 2020-07-31 14:51:13 +05:30
README.md noop: replace subdomain links with subpath (#3869) 2020-02-27 15:43:07 +05:30
requirements.txt docs: bump MarkupSafe version (#4102) 2020-03-13 13:58:54 +05:30

Hasura GraphQL Engine Docs

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

Contributing

Check out the contributing guide for more details.

License

The source code in this directory are under MIT License.