From cd483f3389b3c03aac70e0fbc5b60764ed13679e Mon Sep 17 00:00:00 2001 From: hasura-bot Date: Thu, 3 Mar 2022 04:16:33 -0800 Subject: [PATCH] docs: misc changes GITHUB_PR_NUMBER: 8273 GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/8273 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/3872 Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com> GitOrigin-RevId: d4f0276d9fd8ef0197896808c3b9bf387a231745 --- ...ecrets.rst => mutiple-jwt-secrets.rst.wip} | 2 +- ...ets.rst => rotating-admin-secrets.rst.wip} | 0 .../metadata-api/manage-metadata.rst | 87 +++++++------------ .../metadata-api/query-collections.rst | 8 +- .../ms-sql-server/mutations/update.rst | 2 +- .../core/deployment/production-checklist.rst | 3 +- 6 files changed, 41 insertions(+), 61 deletions(-) rename docs/graphql/cloud/security/{mutiple-jwt-secrets.rst => mutiple-jwt-secrets.rst.wip} (98%) rename docs/graphql/cloud/security/{rotating-admin-secrets.rst => rotating-admin-secrets.rst.wip} (100%) diff --git a/docs/graphql/cloud/security/mutiple-jwt-secrets.rst b/docs/graphql/cloud/security/mutiple-jwt-secrets.rst.wip similarity index 98% rename from docs/graphql/cloud/security/mutiple-jwt-secrets.rst rename to docs/graphql/cloud/security/mutiple-jwt-secrets.rst.wip index 392df7e7238..df69d76bda7 100644 --- a/docs/graphql/cloud/security/mutiple-jwt-secrets.rst +++ b/docs/graphql/cloud/security/mutiple-jwt-secrets.rst.wip @@ -5,7 +5,7 @@ .. _multiple_jwt_secrets: Multiple JWT Secrets -=========== +==================== .. contents:: Table of contents :backlinks: none diff --git a/docs/graphql/cloud/security/rotating-admin-secrets.rst b/docs/graphql/cloud/security/rotating-admin-secrets.rst.wip similarity index 100% rename from docs/graphql/cloud/security/rotating-admin-secrets.rst rename to docs/graphql/cloud/security/rotating-admin-secrets.rst.wip diff --git a/docs/graphql/core/api-reference/metadata-api/manage-metadata.rst b/docs/graphql/core/api-reference/metadata-api/manage-metadata.rst index 9583d94d8d1..537486401e1 100644 --- a/docs/graphql/core/api-reference/metadata-api/manage-metadata.rst +++ b/docs/graphql/core/api-reference/metadata-api/manage-metadata.rst @@ -307,62 +307,41 @@ Response: .. code-block:: json { - "is_consistent": false, - "inconsistent_objects": [ - { - "type": "array_relation", - "definition": { - "name": "articles", - "source": "default", - "comment": null, - "table": { - "schema": "public", - "name": "author" - }, - "using": { - "foreign_key_constraint_on": { - "column": "author_id", - "table": { - "schema": "public", - "name": "article" - } - } - } - }, - "reason": "Inconsistent object: in table \"public.author\": in relationship \"articles\": no foreign constraint exists on the given column(s)" + "is_consistent": false, + "inconsistent_objects": [ + { + "type": "table", + "name": "table public.article in source default", + "definition": { + "schema": "public", + "name": "article" + }, + "reason": "Inconsistent object: no such table/view exists in source: \"public.article\"" + }, + { + "type": "array_relation", + "name": "array_relation articles in table public.author in source default", + "definition": { + "name": "articles", + "source": "default", + "comment": null, + "table": { + "schema": "public", + "name": "author" }, - { - "type": "object_relation", - "definition": { - "name": "authors", - "source": "default", - "comment": "null", - "table": { - "schema": "public", - "name": "article" - }, - "using": { - "foreign_key_constraint_on": { - "column": "author_id", - "table": { - "schema": "public", - "name": "author" - } - } - } - }, - "reason": "table \"article\" does not exist" - }, - { - "type": "table", - "name": "table article in source default", - "definition": { - "schema": "public", - "name": "article" - }, - "reason": "no such table/view exists in source : \"article\"" + "using": { + "foreign_key_constraint_on": { + "column": "author_id", + "table": { + "schema": "public", + "name": "article" + } + } } - ] + }, + "reason": "Inconsistent object: in table \"public.author\": in relationship \"articles\": table \"public.article\" does not exist" + } + ] } .. _metadata_drop_inconsistent_metadata: diff --git a/docs/graphql/core/api-reference/metadata-api/query-collections.rst b/docs/graphql/core/api-reference/metadata-api/query-collections.rst index bf1794b7cff..f137896b81a 100644 --- a/docs/graphql/core/api-reference/metadata-api/query-collections.rst +++ b/docs/graphql/core/api-reference/metadata-api/query-collections.rst @@ -220,7 +220,7 @@ allow-list. It is possible to specify a scope, defaulting to global. If the given collection already exists in the allowlist regardless of scope, ``add_collection_to_allowlist`` is a no-op. To change the -scope, use :ref:`update_scope_of_collection_in_allowlist`. +scope, use :ref:`metadata_update_scope_of_collection_in_allowlist`. If the scope is global, all roles will be able to access the queries present in the query collection: @@ -301,8 +301,8 @@ update_scope_of_collection_in_allowlist ``update_scope_of_collection_in_allowlist`` is used to add change the scope of a collection in the allowlist. Its effect is the same as first dropping the collection from the allowlist using -:ref:`drop_collection_from_allowlist`, and then adding it with the -given scope using :ref:`add_collection_to_allowlist`. +:ref:`metadata_drop_collection_from_allowlist`, and then adding it with the +given scope using :ref:`metadata_add_collection_to_allowlist`. .. code-block:: http @@ -324,7 +324,7 @@ given scope using :ref:`add_collection_to_allowlist`. } } -.. _metadata_update_scope_of_collection_in_allowlist: +.. _metadata_update_scope_of_collection_in_allowlist_syntax: Args Syntax ^^^^^^^^^^^ diff --git a/docs/graphql/core/databases/ms-sql-server/mutations/update.rst b/docs/graphql/core/databases/ms-sql-server/mutations/update.rst index 608af501a82..94f51314f38 100644 --- a/docs/graphql/core/databases/ms-sql-server/mutations/update.rst +++ b/docs/graphql/core/databases/ms-sql-server/mutations/update.rst @@ -43,7 +43,7 @@ Auto-generated update mutation schema As you can see from the schema: -- The ``where`` argument is compulsory to filter rows to be updated. See :ref:`Filter queries <_ms_sql_server_filter_queries>` +- The ``where`` argument is compulsory to filter rows to be updated. See :ref:`Filter queries ` for filtering options. Objects can be updated based on filters on their own fields or those in their nested objects. The ``{}`` expression can be used to update all rows. - You can return the number of affected rows and the affected objects (with nested objects) in the response. diff --git a/docs/graphql/core/deployment/production-checklist.rst b/docs/graphql/core/deployment/production-checklist.rst index 52bd7bceea8..c0d5a9af039 100644 --- a/docs/graphql/core/deployment/production-checklist.rst +++ b/docs/graphql/core/deployment/production-checklist.rst @@ -99,7 +99,8 @@ Read more about all the API types at the :ref:`API reference `. Disable console --------------- -It is recommended that you disable the console on production deployments. Also, +It is recommended that you disable the console on production deployments to +prevent accidental changes to your production environment. Also, when you disable the metadata API, console will stop working. The console is disabled by default.