graphql-engine/docs
Antoine Leblanc bacadc30da Fix several issues with remote relationships.
## Remaining Work

- [x] changelog entry
- [x] more tests: `<backend>_delete_remote_relationship` is definitely untested
- [x] negative tests: we probably want to assert that there are some APIs we DON'T support
- [x] update the console to use the new API, if necessary
- [x] ~~adding the corresponding documentation for the API for other backends (only `pg_` was added here)~~
  - deferred to https://github.com/hasura/graphql-engine-mono/issues/3170
- [x] ~~deciding which backends should support this API~~
  - deferred to https://github.com/hasura/graphql-engine-mono/issues/3170
- [x] ~~deciding what to do about potentially overlapping schematic representations~~
  - ~~cf. https://github.com/hasura/graphql-engine-mono/pull/3157#issuecomment-995307624~~
  - deferred to https://github.com/hasura/graphql-engine-mono/issues/3171
- [x] ~~add more descriptive versioning information to some of the types that are changing in this PR~~
  -  cf. https://github.com/hasura/graphql-engine-mono/pull/3157#discussion_r769830920
  - deferred to https://github.com/hasura/graphql-engine-mono/issues/3172

## Description

This PR fixes several important issues wrt. the remote relationship API.

- it fixes a regression introduced by [#3124](https://github.com/hasura/graphql-engine-mono/pull/3124), which prevented `<backend>_create_remote_relationship` from accepting the old argument format (break of backwards compatibility, broke the console)
- it removes the command `create_remote_relationship` added to the v1/metadata API as a work-around as part of [#3124](https://github.com/hasura/graphql-engine-mono/pull/3124)
- it reverts the subsequent fix in the console: [#3149](https://github.com/hasura/graphql-engine-mono/pull/3149)

Furthermore, this PR also addresses two other issues:
- THE DOCUMENTATION OF THE METADATA API WAS WRONG, and documented `create_remote_relationship` instead of `<backend>_create_remote_relationship`: this PR fixes this by adding `pg_` everywhere, but does not attempt to add the corresponding documentation for other backends, partly because:
- `<backend>_delete_remote_relationship` WAS BROKEN ON NON-POSTGRES BACKENDS; it always expected an argument parameterized by Postgres.

As of main, the `<backend>_(create|update|delete)_remote_relationship` commands are supported on Postgres, Citus, BigQuery, but **NOT MSSQL**. I do not know if this is intentional or not, if it even should be publicized or not, and as a result this PR doesn't change this.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/3157
Co-authored-by: jkachmar <8461423+jkachmar@users.noreply.github.com>
GitOrigin-RevId: 37e2f41522a9229a11c595574c3f4984317d652a
2021-12-16 20:29:19 +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 Fix several issues with remote relationships. 2021-12-16 20:29:19 +00:00
img cloud-docs: add documentation for preview apps 2021-11-03 11:00:35 +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.