graphql-engine/docs/graphql/core
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
..
actions server: add support for nested object type in action 2021-12-15 23:52:43 +00:00
api-reference Fix several issues with remote relationships. 2021-12-16 20:29:19 +00:00
auth docs: remove duplicate text 2021-11-25 11:59:04 +00:00
business-logic docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
databases server/mssql support delete mutations (close hasura/graphql-engine#7626) 2021-11-19 17:06:01 +00:00
deployment docs: fix typo in config examples page 2021-11-25 13:40:28 +00:00
event-triggers docs: add note on computed fields not being part of event trigger payload 2021-11-25 12:39:21 +00:00
getting-started docs: add db current feature support sections 2021-08-26 09:13:25 +00:00
guides docs: add update note for large event/cron logs 2021-11-19 09:36:45 +00:00
hasura-cli tag release v2.1.0 2021-12-14 15:38:26 +00:00
how-it-works docs: add multiple databases and metadata separation docs (#586) 2021-02-23 12:01:19 +00:00
integration docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
introduction docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
migrations docs: use placeholder for version in cli migrations image page 2021-09-16 09:39:08 +00:00
performance docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
remote-schemas docs: add cloud references 2021-07-22 13:24:31 +00:00
scheduled-triggers docs: document clean up steps for scheduled triggers 2021-08-18 16:16:39 +00:00
security-disclosure docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
troubleshooting docs: add cloud references 2021-07-22 13:24:31 +00:00
version-control docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
index.rst docs: add basic FAQs 2021-06-23 11:30:45 +00:00