From 5f6bed2a4fc019d8f9cc4fcbcc6c2d1dbf4f3318 Mon Sep 17 00:00:00 2001 From: Marion Schleifer Date: Sun, 8 Mar 2020 13:25:11 +0100 Subject: [PATCH 1/4] add ref to docs pages --- docs/graphql/manual/actions/action-connect.rst | 2 ++ docs/graphql/manual/actions/action-handlers.rst | 2 ++ docs/graphql/manual/actions/async-actions.rst | 2 ++ docs/graphql/manual/actions/codegen.rst | 2 ++ docs/graphql/manual/actions/create.rst | 4 +++- docs/graphql/manual/actions/derive.rst | 2 ++ docs/graphql/manual/actions/index.rst | 2 ++ docs/graphql/manual/actions/types/index.rst | 2 ++ docs/graphql/manual/api-reference/graphql-api/index.rst | 2 ++ docs/graphql/manual/api-reference/graphql-api/mutation.rst | 2 ++ docs/graphql/manual/api-reference/graphql-api/query.rst | 2 ++ docs/graphql/manual/api-reference/index.rst | 2 +- docs/graphql/manual/api-reference/postgresql-types.rst | 2 ++ .../manual/api-reference/schema-metadata-api/actions.rst | 2 ++ .../api-reference/schema-metadata-api/computed-field.rst | 2 ++ .../api-reference/schema-metadata-api/custom-functions.rst | 2 ++ .../manual/api-reference/schema-metadata-api/custom-types.rst | 2 ++ .../api-reference/schema-metadata-api/event-triggers.rst | 2 ++ .../api-reference/schema-metadata-api/manage-metadata.rst | 2 ++ .../manual/api-reference/schema-metadata-api/permission.rst | 2 ++ .../api-reference/schema-metadata-api/query-collections.rst | 2 ++ .../manual/api-reference/schema-metadata-api/relationship.rst | 2 ++ .../api-reference/schema-metadata-api/remote-schemas.rst | 2 ++ .../manual/api-reference/schema-metadata-api/run-sql.rst | 2 ++ .../manual/api-reference/schema-metadata-api/syntax-defs.rst | 2 ++ .../manual/api-reference/schema-metadata-api/table-view.rst | 2 ++ docs/graphql/manual/auth/authentication/index.rst | 2 ++ docs/graphql/manual/auth/authentication/jwt.rst | 2 ++ .../manual/auth/authentication/unauthenticated-access.rst | 2 ++ docs/graphql/manual/auth/authentication/webhook.rst | 2 ++ docs/graphql/manual/auth/authorization/basics.rst | 2 ++ .../manual/auth/authorization/common-roles-auth-examples.rst | 2 ++ docs/graphql/manual/auth/authorization/index.rst | 2 ++ docs/graphql/manual/auth/authorization/permission-rules.rst | 2 ++ .../graphql/manual/auth/authorization/role-multiple-rules.rst | 2 ++ docs/graphql/manual/auth/authorization/roles-variables.rst | 2 ++ docs/graphql/manual/auth/index.rst | 2 ++ docs/graphql/manual/deployment/allow-list.rst | 2 +- docs/graphql/manual/deployment/compression.rst | 2 +- docs/graphql/manual/deployment/docker/index.rst | 2 ++ docs/graphql/manual/deployment/docker/logging.rst | 2 ++ .../manual/deployment/docker/securing-graphql-endpoint.rst | 2 ++ docs/graphql/manual/deployment/docker/updating.rst | 2 ++ docs/graphql/manual/deployment/downgrading.rst | 2 ++ docs/graphql/manual/deployment/enable-https.rst | 2 +- .../deployment/graphql-engine-flags/config-examples.rst | 2 ++ .../manual/deployment/graphql-engine-flags/reference.rst | 2 ++ docs/graphql/manual/deployment/heroku/index.rst | 2 ++ docs/graphql/manual/deployment/heroku/logging.rst | 2 ++ .../manual/deployment/heroku/securing-graphql-endpoint.rst | 2 ++ docs/graphql/manual/deployment/heroku/updating.rst | 2 ++ .../deployment/heroku/using-existing-heroku-database.rst | 2 ++ docs/graphql/manual/deployment/index.rst | 2 ++ docs/graphql/manual/deployment/kubernetes/index.rst | 2 ++ docs/graphql/manual/deployment/kubernetes/logging.rst | 2 ++ .../deployment/kubernetes/securing-graphql-endpoint.rst | 2 ++ docs/graphql/manual/deployment/kubernetes/updating.rst | 2 ++ docs/graphql/manual/deployment/postgres-permissions.rst | 2 ++ docs/graphql/manual/deployment/production-checklist.rst | 2 +- docs/graphql/manual/deployment/securing-graphql-endpoint.rst | 2 +- docs/graphql/manual/deployment/updating.rst | 2 ++ docs/graphql/manual/event-triggers/clean-up.rst | 2 ++ docs/graphql/manual/event-triggers/create-trigger.rst | 2 ++ docs/graphql/manual/event-triggers/index.rst | 2 ++ docs/graphql/manual/event-triggers/invoke-trigger-console.rst | 2 ++ docs/graphql/manual/event-triggers/payload.rst | 2 ++ docs/graphql/manual/event-triggers/samples.rst | 2 ++ docs/graphql/manual/event-triggers/serverless.rst | 2 ++ docs/graphql/manual/getting-started/docker-simple.rst | 2 ++ docs/graphql/manual/getting-started/first-event-trigger.rst | 2 ++ docs/graphql/manual/getting-started/first-graphql-query.rst | 2 ++ docs/graphql/manual/getting-started/heroku-simple.rst | 2 ++ docs/graphql/manual/getting-started/index.rst | 2 ++ .../manual/getting-started/using-existing-database.rst | 2 ++ docs/graphql/manual/guides/auditing-tables.rst | 2 ++ docs/graphql/manual/guides/code-editor-integrations/index.rst | 2 ++ .../guides/code-editor-integrations/visual-studio-code.rst | 2 ++ docs/graphql/manual/guides/data-modelling/index.rst | 2 ++ .../manual/guides/deployment/digital-ocean-one-click.rst | 2 ++ .../guides/deployment/google-kubernetes-engine-cloud-sql.rst | 2 ++ docs/graphql/manual/guides/deployment/index.rst | 2 ++ docs/graphql/manual/guides/index.rst | 2 ++ .../manual/guides/integrations/apollo-subscriptions.rst | 2 ++ docs/graphql/manual/guides/integrations/index.rst | 2 ++ docs/graphql/manual/guides/monitoring/index.rst | 2 ++ docs/graphql/manual/guides/sample-apps/index.rst | 2 ++ docs/graphql/manual/how-it-works/index.rst | 2 ++ docs/graphql/manual/migrations/advanced/index.rst | 2 ++ .../manual/migrations/advanced/rolling-back-migrations.rst | 2 ++ .../manual/migrations/advanced/seed-data-migration.rst | 2 ++ .../migrations/advanced/writing-migrations-manually.rst | 2 ++ docs/graphql/manual/migrations/existing-database.rst | 2 ++ docs/graphql/manual/migrations/new-database.rst | 2 ++ docs/graphql/manual/migrations/reference/how-it-works.rst | 2 ++ docs/graphql/manual/migrations/reference/index.rst | 2 ++ docs/graphql/manual/mutations/delete.rst | 2 ++ docs/graphql/manual/mutations/index.rst | 2 ++ docs/graphql/manual/mutations/insert.rst | 2 ++ docs/graphql/manual/mutations/multiple-mutations.rst | 2 ++ docs/graphql/manual/mutations/update.rst | 2 ++ docs/graphql/manual/mutations/upsert.rst | 2 ++ docs/graphql/manual/queries/aggregation-queries.rst | 2 ++ docs/graphql/manual/queries/distinct-queries.rst | 2 ++ docs/graphql/manual/queries/index.rst | 2 ++ docs/graphql/manual/queries/multiple-arguments.rst | 2 ++ docs/graphql/manual/queries/multiple-queries.rst | 2 ++ docs/graphql/manual/queries/nested-object-queries.rst | 2 ++ docs/graphql/manual/queries/pagination.rst | 2 ++ docs/graphql/manual/queries/query-filters.rst | 2 ++ docs/graphql/manual/queries/simple-object-queries.rst | 2 ++ docs/graphql/manual/queries/sorting.rst | 2 ++ .../manual/queries/variables-aliases-fragments-directives.rst | 2 ++ docs/graphql/manual/remote-schemas/index.rst | 2 ++ docs/graphql/manual/schema/basics.rst | 2 ++ docs/graphql/manual/schema/computed-fields.rst | 2 ++ docs/graphql/manual/schema/default-values/column-presets.rst | 2 ++ docs/graphql/manual/schema/default-values/index.rst | 2 ++ .../manual/schema/default-values/postgres-defaults.rst | 2 ++ docs/graphql/manual/schema/default-values/sql-functions.rst | 2 ++ docs/graphql/manual/schema/enums.rst | 2 ++ docs/graphql/manual/schema/export-graphql-schema.rst | 2 ++ docs/graphql/manual/schema/index.rst | 2 ++ docs/graphql/manual/schema/relationships/create.rst | 2 ++ .../manual/schema/relationships/database-modelling/index.rst | 2 ++ docs/graphql/manual/schema/relationships/index.rst | 1 - docs/graphql/manual/schema/relationships/rename.rst | 2 ++ docs/graphql/manual/schema/using-existing-database.rst | 2 ++ docs/graphql/manual/security-disclosure/index.rst | 2 ++ docs/graphql/manual/subscriptions/index.rst | 2 ++ docs/graphql/manual/subscriptions/use-cases.rst | 2 ++ docs/graphql/manual/troubleshooting/index.rst | 2 ++ 131 files changed, 255 insertions(+), 8 deletions(-) diff --git a/docs/graphql/manual/actions/action-connect.rst b/docs/graphql/manual/actions/action-connect.rst index 72f8155746ab1..40476d8042cdd 100644 --- a/docs/graphql/manual/actions/action-connect.rst +++ b/docs/graphql/manual/actions/action-connect.rst @@ -1,3 +1,5 @@ +.. _connect: + Connecting actions with the graph ================================= diff --git a/docs/graphql/manual/actions/action-handlers.rst b/docs/graphql/manual/actions/action-handlers.rst index 04584bec13830..650aa507ffe0e 100644 --- a/docs/graphql/manual/actions/action-handlers.rst +++ b/docs/graphql/manual/actions/action-handlers.rst @@ -1,3 +1,5 @@ +.. _action_handlers: + Action handlers =============== diff --git a/docs/graphql/manual/actions/async-actions.rst b/docs/graphql/manual/actions/async-actions.rst index afbe42986fc0e..c48d4d944f290 100644 --- a/docs/graphql/manual/actions/async-actions.rst +++ b/docs/graphql/manual/actions/async-actions.rst @@ -1,3 +1,5 @@ +.. _async_actions: + Async actions ============= diff --git a/docs/graphql/manual/actions/codegen.rst b/docs/graphql/manual/actions/codegen.rst index e082aa43f87bf..f73d4c4a796b2 100644 --- a/docs/graphql/manual/actions/codegen.rst +++ b/docs/graphql/manual/actions/codegen.rst @@ -1,3 +1,5 @@ +.. _codegen: + Actions codegen =============== diff --git a/docs/graphql/manual/actions/create.rst b/docs/graphql/manual/actions/create.rst index 2a25312b2ea16..d3d232fef3e2e 100644 --- a/docs/graphql/manual/actions/create.rst +++ b/docs/graphql/manual/actions/create.rst @@ -1,3 +1,5 @@ +.. _create_actions: + Creating actions ================ @@ -223,4 +225,4 @@ In the Hasura console, head to the ``GraphiQL`` tab and try out the new action. } } -And that's it. You have created your first action! \ No newline at end of file +And that's it. You have created your first action! diff --git a/docs/graphql/manual/actions/derive.rst b/docs/graphql/manual/actions/derive.rst index 6efe2bd6b2e24..d01c8b97ba898 100644 --- a/docs/graphql/manual/actions/derive.rst +++ b/docs/graphql/manual/actions/derive.rst @@ -1,3 +1,5 @@ +.. _derive: + Deriving actions ================ diff --git a/docs/graphql/manual/actions/index.rst b/docs/graphql/manual/actions/index.rst index aefdde51f0b87..6f80d99bce2e5 100644 --- a/docs/graphql/manual/actions/index.rst +++ b/docs/graphql/manual/actions/index.rst @@ -1,3 +1,5 @@ +.. _actions: + Actions (beta) ============== diff --git a/docs/graphql/manual/actions/types/index.rst b/docs/graphql/manual/actions/types/index.rst index 64068192020dc..09abaeeb9a610 100644 --- a/docs/graphql/manual/actions/types/index.rst +++ b/docs/graphql/manual/actions/types/index.rst @@ -1,3 +1,5 @@ +.. _custom_types: + Custom GraphQL types ==================== diff --git a/docs/graphql/manual/api-reference/graphql-api/index.rst b/docs/graphql/manual/api-reference/graphql-api/index.rst index 6d7ec8e6ef238..5665f005e0306 100644 --- a/docs/graphql/manual/api-reference/graphql-api/index.rst +++ b/docs/graphql/manual/api-reference/graphql-api/index.rst @@ -2,6 +2,8 @@ :description: Hasura GraphQL API reference :keywords: hasura, docs, GraphQL API, reference +.. _graphql_api: + GraphQL API Reference ===================== diff --git a/docs/graphql/manual/api-reference/graphql-api/mutation.rst b/docs/graphql/manual/api-reference/graphql-api/mutation.rst index 9f1bab17afbeb..6e644b526140d 100644 --- a/docs/graphql/manual/api-reference/graphql-api/mutation.rst +++ b/docs/graphql/manual/api-reference/graphql-api/mutation.rst @@ -2,6 +2,8 @@ :description: Hasura GraphQL API mutations API reference :keywords: hasura, docs, GraphQL API, API reference, mutation +.. _graphql_api_mutation: + API Reference - Mutation ======================== diff --git a/docs/graphql/manual/api-reference/graphql-api/query.rst b/docs/graphql/manual/api-reference/graphql-api/query.rst index 765898805986f..d72f60cdc2c60 100644 --- a/docs/graphql/manual/api-reference/graphql-api/query.rst +++ b/docs/graphql/manual/api-reference/graphql-api/query.rst @@ -2,6 +2,8 @@ :description: Hasura GraphQL API queries and subscriptions API reference :keywords: hasura, docs, GraphQL API, API reference, query, subscription +.. _graphql_api_query: + API Reference - Query / Subscription ==================================== diff --git a/docs/graphql/manual/api-reference/index.rst b/docs/graphql/manual/api-reference/index.rst index 9d3e869d050a8..78a0a43ff75e7 100644 --- a/docs/graphql/manual/api-reference/index.rst +++ b/docs/graphql/manual/api-reference/index.rst @@ -2,7 +2,7 @@ :description: Hasura API reference :keywords: hasura, docs, API, API reference -.. _api-reference: +.. _api_reference: API Reference ============= diff --git a/docs/graphql/manual/api-reference/postgresql-types.rst b/docs/graphql/manual/api-reference/postgresql-types.rst index 7c12d87faf72b..1d2ed6cc7ee94 100644 --- a/docs/graphql/manual/api-reference/postgresql-types.rst +++ b/docs/graphql/manual/api-reference/postgresql-types.rst @@ -2,6 +2,8 @@ :description: Supported PostgreSQL types in the Hasura API :keywords: hasura, docs, PostgreSQL types, API reference +.. _api_postgres_types: + API Reference - Supported PostgreSQL Types ========================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst b/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst index e84ac83ce6749..46a7c848b02bf 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst @@ -2,6 +2,8 @@ :description: Manage actions with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, actions +.. _api_actions: + Schema/Metadata API Reference: Actions ====================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/computed-field.rst b/docs/graphql/manual/api-reference/schema-metadata-api/computed-field.rst index f3894861be8cb..a347357652617 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/computed-field.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/computed-field.rst @@ -2,6 +2,8 @@ :description: Manage computed fields with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, computed field +.. _api_computed_field: + Schema/Metadata API Reference: Computed Fields ============================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/custom-functions.rst b/docs/graphql/manual/api-reference/schema-metadata-api/custom-functions.rst index b8a247d76336d..2751a8ee0034b 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/custom-functions.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/custom-functions.rst @@ -2,6 +2,8 @@ :description: Manage custom functions with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, custom function +.. _api_custom_functions: + Schema/Metadata API Reference: Custom Functions =============================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst b/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst index a0e2926cdba93..2d09bbc279c78 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst @@ -2,6 +2,8 @@ :description: Define custom types with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, custom types +.. _api_custom_types: + Schema/Metadata API Reference: Custom Types =========================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/event-triggers.rst b/docs/graphql/manual/api-reference/schema-metadata-api/event-triggers.rst index 0ed1994e25357..3caf8ee8d935f 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/event-triggers.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/event-triggers.rst @@ -2,6 +2,8 @@ :description: Manage event triggers with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, event trigger +.. _api_event_triggers: + Schema/Metadata API Reference: Event Triggers ============================================= diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/manage-metadata.rst b/docs/graphql/manual/api-reference/schema-metadata-api/manage-metadata.rst index 729a070092a22..c7991b0efd79b 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/manage-metadata.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/manage-metadata.rst @@ -2,6 +2,8 @@ :description: Manage metadata with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, metadata +.. _api_manage_metadata: + Schema/Metadata API Reference: Manage metadata ============================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/permission.rst b/docs/graphql/manual/api-reference/schema-metadata-api/permission.rst index c89bd5165cd57..3c360b105d963 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/permission.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/permission.rst @@ -2,6 +2,8 @@ :description: Manage permissions with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, permission +.. _api_permission: + Schema/Metadata API Reference: Permissions ========================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/query-collections.rst b/docs/graphql/manual/api-reference/schema-metadata-api/query-collections.rst index ad23fda77657d..6ec5f8e0e36f0 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/query-collections.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/query-collections.rst @@ -2,6 +2,8 @@ :description: Manage query collections with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, query collection +.. _api_query_collections: + Schema/Metadata API Reference: Query collections ================================================ diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst b/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst index 4dd03fb7ed924..14f7998e43d6b 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/relationship.rst @@ -2,6 +2,8 @@ :description: Use relationships with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, relationship +.. _api_relationship: + Schema/Metadata API Reference: Relationships ============================================ diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/remote-schemas.rst b/docs/graphql/manual/api-reference/schema-metadata-api/remote-schemas.rst index dc082fdbe0fd8..f42a7b600e263 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/remote-schemas.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/remote-schemas.rst @@ -2,6 +2,8 @@ :description: Manage remote schemas with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, remote schema +.. _api_remote_schemas: + Schema/Metadata API Reference: Remote schemas ============================================= diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/run-sql.rst b/docs/graphql/manual/api-reference/schema-metadata-api/run-sql.rst index fd13bd35c4825..05e32e763675e 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/run-sql.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/run-sql.rst @@ -2,6 +2,8 @@ :description: Execute SQL with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, run_sql +.. _api_run_sql: + Schema/Metadata API Reference: Run SQL ====================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst b/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst index 23b5c49a89801..278cc19d36d02 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst @@ -2,6 +2,8 @@ :description: Common syntax definitions for the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, syntax definitions +.. _api_syntax_defs: + Schema/Metadata API Reference: Common syntax definitions ======================================================== diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/table-view.rst b/docs/graphql/manual/api-reference/schema-metadata-api/table-view.rst index c3f315d8357e4..01d95a1e0eb31 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/table-view.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/table-view.rst @@ -2,6 +2,8 @@ :description: Manage tables and views with the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, table, view +.. _api_tables_views: + Schema/Metadata API Reference: Tables/Views =========================================== diff --git a/docs/graphql/manual/auth/authentication/index.rst b/docs/graphql/manual/auth/authentication/index.rst index 0ad634edabcb8..133f8786cf2ab 100644 --- a/docs/graphql/manual/auth/authentication/index.rst +++ b/docs/graphql/manual/auth/authentication/index.rst @@ -2,6 +2,8 @@ :description: Manage authenticaton with Hasura :keywords: hasura, docs, authentication, auth +.. _authentication: + Authentication ============== diff --git a/docs/graphql/manual/auth/authentication/jwt.rst b/docs/graphql/manual/auth/authentication/jwt.rst index 9760da1f8ab1f..823ada07961f8 100644 --- a/docs/graphql/manual/auth/authentication/jwt.rst +++ b/docs/graphql/manual/auth/authentication/jwt.rst @@ -2,6 +2,8 @@ :description: Use authenticaton with JWT in Hasura :keywords: hasura, docs, authentication, auth, JWT +.. _auth_jwt: + Authentication using JWT ======================== diff --git a/docs/graphql/manual/auth/authentication/unauthenticated-access.rst b/docs/graphql/manual/auth/authentication/unauthenticated-access.rst index f6c9d19562408..a5ac4126a7ffa 100644 --- a/docs/graphql/manual/auth/authentication/unauthenticated-access.rst +++ b/docs/graphql/manual/auth/authentication/unauthenticated-access.rst @@ -2,6 +2,8 @@ :description: Manage unauthenticated access in Hasura :keywords: hasura, docs, authentication, auth, unauthenticated access +.. _unauthenticated_access: + Unauthenticated access ====================== diff --git a/docs/graphql/manual/auth/authentication/webhook.rst b/docs/graphql/manual/auth/authentication/webhook.rst index aa101aab53d51..9cc7079361d52 100644 --- a/docs/graphql/manual/auth/authentication/webhook.rst +++ b/docs/graphql/manual/auth/authentication/webhook.rst @@ -2,6 +2,8 @@ :description: Use authenticaton with webhooks in Hasura :keywords: hasura, docs, authentication, auth, webhook +.. _auth_webhooks: + Authentication using webhooks ============================= diff --git a/docs/graphql/manual/auth/authorization/basics.rst b/docs/graphql/manual/auth/authorization/basics.rst index a87a7d7cedd28..67d9f43318a65 100644 --- a/docs/graphql/manual/auth/authorization/basics.rst +++ b/docs/graphql/manual/auth/authorization/basics.rst @@ -2,6 +2,8 @@ :description: Hasura access control basics :keywords: hasura, docs, authorization, access control +.. _auth_basics: + Access control basics ===================== diff --git a/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst b/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst index b7775565720fd..d40d603fb8c98 100644 --- a/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst +++ b/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst @@ -2,6 +2,8 @@ :description: Examples for managing access control with Hasura :keywords: hasura, docs, authorization, access control, examples +.. _auth_examples: + Access control examples ======================= diff --git a/docs/graphql/manual/auth/authorization/index.rst b/docs/graphql/manual/auth/authorization/index.rst index 9b2ed185c2045..ff252bde23d71 100644 --- a/docs/graphql/manual/auth/authorization/index.rst +++ b/docs/graphql/manual/auth/authorization/index.rst @@ -2,6 +2,8 @@ :description: Manage authorization with Hasura :keywords: hasura, docs, authorization, auth +.. _authorization: + Authorization / Access control ============================== diff --git a/docs/graphql/manual/auth/authorization/permission-rules.rst b/docs/graphql/manual/auth/authorization/permission-rules.rst index d00c3d2b55a98..dcbb6710d8311 100644 --- a/docs/graphql/manual/auth/authorization/permission-rules.rst +++ b/docs/graphql/manual/auth/authorization/permission-rules.rst @@ -2,6 +2,8 @@ :description: Configure permission rules in Hasura :keywords: hasura, docs, authorization, permissions, rules +.. _permission_rules: + Configuring Permission Rules ============================ diff --git a/docs/graphql/manual/auth/authorization/role-multiple-rules.rst b/docs/graphql/manual/auth/authorization/role-multiple-rules.rst index 6cc3f974004f0..627ae55db98be 100644 --- a/docs/graphql/manual/auth/authorization/role-multiple-rules.rst +++ b/docs/graphql/manual/auth/authorization/role-multiple-rules.rst @@ -2,6 +2,8 @@ :description: Manage multiple column + row permissions for the same role in Hasura :keywords: hasura, docs, authorization, access control, permission, role +.. _role_multiple_rules: + Multiple column + row permissions for the same role =================================================== diff --git a/docs/graphql/manual/auth/authorization/roles-variables.rst b/docs/graphql/manual/auth/authorization/roles-variables.rst index 374bf600e77b9..065c8edc95f95 100644 --- a/docs/graphql/manual/auth/authorization/roles-variables.rst +++ b/docs/graphql/manual/auth/authorization/roles-variables.rst @@ -2,6 +2,8 @@ :description: Manage roles and session variables for permissions with Hasura :keywords: hasura, docs, authorization, access control, permission, role, session variable +.. _roles_variables: + Roles & Session variables ========================= diff --git a/docs/graphql/manual/auth/index.rst b/docs/graphql/manual/auth/index.rst index 3b3b8ce0b10d7..b57f903eb99af 100644 --- a/docs/graphql/manual/auth/index.rst +++ b/docs/graphql/manual/auth/index.rst @@ -2,6 +2,8 @@ :description: Manage GraphQL Authentication and Authorization with Hasura :keywords: hasura, docs, authentication, auth, authorization +.. _auth: + Authentication & Authorization ============================== diff --git a/docs/graphql/manual/deployment/allow-list.rst b/docs/graphql/manual/deployment/allow-list.rst index 13bc3bbc7b6ed..91c0003ac73bc 100644 --- a/docs/graphql/manual/deployment/allow-list.rst +++ b/docs/graphql/manual/deployment/allow-list.rst @@ -2,7 +2,7 @@ :description: Manage allow list with Hasura GraphQL engine :keywords: hasura, docs, deployment, allow list -.. _allow-list: +.. _allow_list: Allow-list for queries ====================== diff --git a/docs/graphql/manual/deployment/compression.rst b/docs/graphql/manual/deployment/compression.rst index 175cf872cace6..7b26199839052 100644 --- a/docs/graphql/manual/deployment/compression.rst +++ b/docs/graphql/manual/deployment/compression.rst @@ -2,7 +2,7 @@ :description: Use HTTP compression with Hasura GraphQL engine :keywords: hasura, docs, deployment, http compression -.. _http-compression: +.. _http_compression: HTTP Compression ================ diff --git a/docs/graphql/manual/deployment/docker/index.rst b/docs/graphql/manual/deployment/docker/index.rst index 04faa13c704d6..1338f86f7e0f2 100644 --- a/docs/graphql/manual/deployment/docker/index.rst +++ b/docs/graphql/manual/deployment/docker/index.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine with Docker :keywords: hasura, docs, deployment, docker +.. _deployment_docker: + Run Hasura GraphQL engine using Docker ====================================== diff --git a/docs/graphql/manual/deployment/docker/logging.rst b/docs/graphql/manual/deployment/docker/logging.rst index d54404cf77c1a..b3e4aac28e136 100644 --- a/docs/graphql/manual/deployment/docker/logging.rst +++ b/docs/graphql/manual/deployment/docker/logging.rst @@ -2,6 +2,8 @@ :description: Get Hasura GraphQL engine server logs with Docker deployment :keywords: hasura, docs, deployment, docker, logs +.. _docker_logs: + Hasura GraphQL engine server logs (Docker) ========================================== diff --git a/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst index 6db2d35a6db37..9ad7bb8860581 100644 --- a/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst @@ -2,6 +2,8 @@ :description: Secure Hasura GraphQL endpoint with Docker deployment :keywords: hasura, docs, deployment, docker, secure +.. _docker_secure: + Securing the GraphQL endpoint (Docker) ====================================== diff --git a/docs/graphql/manual/deployment/docker/updating.rst b/docs/graphql/manual/deployment/docker/updating.rst index be0b12901ec51..9b5172b4baa2f 100644 --- a/docs/graphql/manual/deployment/docker/updating.rst +++ b/docs/graphql/manual/deployment/docker/updating.rst @@ -2,6 +2,8 @@ :description: Update Hasura GraphQL engine with Docker deployment :keywords: hasura, docs, deployment, docker, update +.. _docker_update: + Updating Hasura GraphQL engine running with Docker ================================================== diff --git a/docs/graphql/manual/deployment/downgrading.rst b/docs/graphql/manual/deployment/downgrading.rst index 2f5f3aeb47e7a..5dc8d3ca3f45e 100644 --- a/docs/graphql/manual/deployment/downgrading.rst +++ b/docs/graphql/manual/deployment/downgrading.rst @@ -2,6 +2,8 @@ :description: Downgrade Hasura GraphQL engine version :keywords: hasura, docs, deployment, downgrade, version +.. _downgrade_hge: + Downgrading Hasura GraphQL engine ================================= diff --git a/docs/graphql/manual/deployment/enable-https.rst b/docs/graphql/manual/deployment/enable-https.rst index 724b147161c16..94eebe141f478 100644 --- a/docs/graphql/manual/deployment/enable-https.rst +++ b/docs/graphql/manual/deployment/enable-https.rst @@ -2,7 +2,7 @@ :description: Enable HTTPS with Hasura GraphQL engine :keywords: hasura, docs, deployment, https -.. _enable-https: +.. _enable_https: Enable HTTPS ============ diff --git a/docs/graphql/manual/deployment/graphql-engine-flags/config-examples.rst b/docs/graphql/manual/deployment/graphql-engine-flags/config-examples.rst index fbfa695513efe..7f70cc0199cda 100644 --- a/docs/graphql/manual/deployment/graphql-engine-flags/config-examples.rst +++ b/docs/graphql/manual/deployment/graphql-engine-flags/config-examples.rst @@ -2,6 +2,8 @@ :description: Examples of server configurations with Hasura GraphQL engine :keywords: hasura, docs, deployment, flags, server, server configuration, example +.. _config_examples: + GraphQL engine server config examples ===================================== diff --git a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst index 5f2661ce9baeb..76db860104536 100644 --- a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst +++ b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst @@ -2,6 +2,8 @@ :description: Hasura GraphQL engine server flags reference :keywords: hasura, docs, deployment, server, flags +.. _server_flag_reference: + GraphQL engine server flags reference ===================================== diff --git a/docs/graphql/manual/deployment/heroku/index.rst b/docs/graphql/manual/deployment/heroku/index.rst index 23092b55c134b..843df5e2a4746 100644 --- a/docs/graphql/manual/deployment/heroku/index.rst +++ b/docs/graphql/manual/deployment/heroku/index.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine with Heroku :keywords: hasura, docs, deployment, heroku +.. _deploy_heroku: + Run Hasura GraphQL engine on Heroku =================================== diff --git a/docs/graphql/manual/deployment/heroku/logging.rst b/docs/graphql/manual/deployment/heroku/logging.rst index f317687524926..fdfd4f7f76c45 100644 --- a/docs/graphql/manual/deployment/heroku/logging.rst +++ b/docs/graphql/manual/deployment/heroku/logging.rst @@ -2,6 +2,8 @@ :description: Get Hasura GraphQL engine server logs with Heroku deployment :keywords: hasura, docs, deployment, heroku, logs +.. _heroku_logs: + Hasura GraphQL engine server logs (Heroku) ========================================== diff --git a/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst index 59761a7e97d19..347d5f235b107 100644 --- a/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst @@ -2,6 +2,8 @@ :description: Secure Hasura GraphQL endpoint with Heroku deployment :keywords: hasura, docs, deployment, heroku, secure +.. _heroku_secure: + Securing the GraphQL endpoint (Heroku) ====================================== diff --git a/docs/graphql/manual/deployment/heroku/updating.rst b/docs/graphql/manual/deployment/heroku/updating.rst index f20ec9b668810..ff00dc70f71eb 100644 --- a/docs/graphql/manual/deployment/heroku/updating.rst +++ b/docs/graphql/manual/deployment/heroku/updating.rst @@ -2,6 +2,8 @@ :description: Update Hasura GraphQL engine with Heroku deployment :keywords: hasura, docs, deployment, heroku, update +.. _heroku_update: + Updating Hasura GraphQL engine on Heroku ======================================== diff --git a/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst b/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst index cf8fc547521fe..1c7ef91e861ac 100644 --- a/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst +++ b/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst @@ -2,6 +2,8 @@ :description: Use an existing database with Heroku deployment :keywords: hasura, docs, deployment, heroku, existing database +.. _heroku_existing_db: + Using an existing Heroku database ================================= diff --git a/docs/graphql/manual/deployment/index.rst b/docs/graphql/manual/deployment/index.rst index 4b34d68f91b2a..d323379a81563 100644 --- a/docs/graphql/manual/deployment/index.rst +++ b/docs/graphql/manual/deployment/index.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine :keywords: hasura, docs, deployment +.. _deployment: + Deploying Hasura GraphQL engine =============================== diff --git a/docs/graphql/manual/deployment/kubernetes/index.rst b/docs/graphql/manual/deployment/kubernetes/index.rst index 7c5aed198a38c..16c4f80ece1d7 100644 --- a/docs/graphql/manual/deployment/kubernetes/index.rst +++ b/docs/graphql/manual/deployment/kubernetes/index.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine with Kubernetes :keywords: hasura, docs, deployment, kubernetes +.. _deploy_kubernetes: + Run Hasura GraphQL engine on Kubernetes ======================================= diff --git a/docs/graphql/manual/deployment/kubernetes/logging.rst b/docs/graphql/manual/deployment/kubernetes/logging.rst index 1b07f96611261..6bccf44d705a6 100644 --- a/docs/graphql/manual/deployment/kubernetes/logging.rst +++ b/docs/graphql/manual/deployment/kubernetes/logging.rst @@ -2,6 +2,8 @@ :description: Get Hasura GraphQL engine server logs with Kubernetes deployment :keywords: hasura, docs, deployment, kubernetes, logs +.. _kubernetes_logs: + Hasura GraphQL engine server logs (Kubernetes) ============================================== diff --git a/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst index 399f18f98bd86..38c7309ccf838 100644 --- a/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst @@ -2,6 +2,8 @@ :description: Secure Hasura GraphQL endpoint with Kubernetes deployment :keywords: hasura, docs, deployment, kubernetes, secure +.. _kubernetes_secure: + Securing the GraphQL endpoint (Kubernetes) ========================================== diff --git a/docs/graphql/manual/deployment/kubernetes/updating.rst b/docs/graphql/manual/deployment/kubernetes/updating.rst index b9bcae826ba6e..e379c936b026f 100644 --- a/docs/graphql/manual/deployment/kubernetes/updating.rst +++ b/docs/graphql/manual/deployment/kubernetes/updating.rst @@ -2,6 +2,8 @@ :description: Update Hasura GraphQL engine with Kubernetes deployment :keywords: hasura, docs, deployment, kubernetes, update +.. _kubernetes_update: + Updating Hasura GraphQL engine running on Kubernetes ==================================================== diff --git a/docs/graphql/manual/deployment/postgres-permissions.rst b/docs/graphql/manual/deployment/postgres-permissions.rst index a2972c30a319e..c891fa1a59ce0 100644 --- a/docs/graphql/manual/deployment/postgres-permissions.rst +++ b/docs/graphql/manual/deployment/postgres-permissions.rst @@ -2,6 +2,8 @@ :description: Required Postgres permissions for Hasura GraphQL engine :keywords: hasura, docs, deployment, postgres, postgres permissions +.. _postgres_permissions: + Postgres permissions ==================== diff --git a/docs/graphql/manual/deployment/production-checklist.rst b/docs/graphql/manual/deployment/production-checklist.rst index 2e24b59516bf4..e9349352d5483 100644 --- a/docs/graphql/manual/deployment/production-checklist.rst +++ b/docs/graphql/manual/deployment/production-checklist.rst @@ -2,7 +2,7 @@ :description: Checklist for deploying Hasura GraphQL engine to production :keywords: hasura, docs, deployment, production, checklist -.. _production-checklist: +.. _production_checklist: Production checklist ==================== diff --git a/docs/graphql/manual/deployment/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/securing-graphql-endpoint.rst index de2ac82221430..c6624b9985390 100644 --- a/docs/graphql/manual/deployment/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/securing-graphql-endpoint.rst @@ -2,7 +2,7 @@ :description: Secure the Hasura GraphQL endpoint :keywords: hasura, docs, deployment, secure -.. _securing-graphql-endpoint: +.. _securing_graphql_endpoint: Securing the GraphQL endpoint ============================= diff --git a/docs/graphql/manual/deployment/updating.rst b/docs/graphql/manual/deployment/updating.rst index e694ea8c8493b..3216757b4d3da 100644 --- a/docs/graphql/manual/deployment/updating.rst +++ b/docs/graphql/manual/deployment/updating.rst @@ -2,6 +2,8 @@ :description: Update Hasura GraphQL engine version :keywords: hasura, docs, deployment, update, version +.. _update_hge: + Updating Hasura GraphQL engine ============================== diff --git a/docs/graphql/manual/event-triggers/clean-up.rst b/docs/graphql/manual/event-triggers/clean-up.rst index da63993af728f..21142ada51216 100644 --- a/docs/graphql/manual/event-triggers/clean-up.rst +++ b/docs/graphql/manual/event-triggers/clean-up.rst @@ -2,6 +2,8 @@ :description: Clean up event data of event triggers in Hasura :keywords: hasura, docs, event trigger, event data, clean up +.. _clean_up: + Clean up event data =================== .. contents:: Table of contents diff --git a/docs/graphql/manual/event-triggers/create-trigger.rst b/docs/graphql/manual/event-triggers/create-trigger.rst index be4002a781df6..684e5b72d9f82 100644 --- a/docs/graphql/manual/event-triggers/create-trigger.rst +++ b/docs/graphql/manual/event-triggers/create-trigger.rst @@ -2,6 +2,8 @@ :description: Create an event trigger with Hasura :keywords: hasura, docs, event trigger, create +.. _create_trigger: + Creating an event trigger ========================= diff --git a/docs/graphql/manual/event-triggers/index.rst b/docs/graphql/manual/event-triggers/index.rst index c66469adfeb5b..c47770d9627fa 100644 --- a/docs/graphql/manual/event-triggers/index.rst +++ b/docs/graphql/manual/event-triggers/index.rst @@ -2,6 +2,8 @@ :description: Manage event triggers with Hasura :keywords: hasura, docs, event trigger +.. _event_triggers: + Event Triggers ============== diff --git a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst index fd37dcd7124fd..62b337b6566e5 100644 --- a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst +++ b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst @@ -2,6 +2,8 @@ :description: Invoke event triggers on the Hasura console :keywords: hasura, docs, event trigger, console, invoke +.. _invoke_trigger: + Invoke event trigger via console ================================ diff --git a/docs/graphql/manual/event-triggers/payload.rst b/docs/graphql/manual/event-triggers/payload.rst index 7b9b3304c803d..b8f3ac8a4ac58 100644 --- a/docs/graphql/manual/event-triggers/payload.rst +++ b/docs/graphql/manual/event-triggers/payload.rst @@ -2,6 +2,8 @@ :description: Event trigger payload in Hasura :keywords: hasura, docs, event trigger, payload +.. _trigger_payload: + Event trigger payload ===================== diff --git a/docs/graphql/manual/event-triggers/samples.rst b/docs/graphql/manual/event-triggers/samples.rst index 71972dba64437..27e61092b7d4f 100644 --- a/docs/graphql/manual/event-triggers/samples.rst +++ b/docs/graphql/manual/event-triggers/samples.rst @@ -2,6 +2,8 @@ :description: Examples for event triggers with Hasura :keywords: hasura, docs, event trigger, example +.. _trigger_samples: + Event trigger samples ===================== diff --git a/docs/graphql/manual/event-triggers/serverless.rst b/docs/graphql/manual/event-triggers/serverless.rst index 0ac7833b91901..add5159a04377 100644 --- a/docs/graphql/manual/event-triggers/serverless.rst +++ b/docs/graphql/manual/event-triggers/serverless.rst @@ -2,6 +2,8 @@ :description: Use serverless functions with Hasura event triggers :keywords: hasura, docs, event trigger, serverless function +.. _serverless: + Using serverless functions ========================== diff --git a/docs/graphql/manual/getting-started/docker-simple.rst b/docs/graphql/manual/getting-started/docker-simple.rst index e6026c0a4a35b..26e014b60d897 100644 --- a/docs/graphql/manual/getting-started/docker-simple.rst +++ b/docs/graphql/manual/getting-started/docker-simple.rst @@ -2,6 +2,8 @@ :description: Get started with Hasura using Docker :keywords: hasura, docs, start, docker +.. _docker_simple: + Quickstart with Docker ====================== diff --git a/docs/graphql/manual/getting-started/first-event-trigger.rst b/docs/graphql/manual/getting-started/first-event-trigger.rst index bc29a04807a7b..8466cb2566e4d 100644 --- a/docs/graphql/manual/getting-started/first-event-trigger.rst +++ b/docs/graphql/manual/getting-started/first-event-trigger.rst @@ -2,6 +2,8 @@ :description: Set up a first event trigger with Hasura :keywords: hasura, docs, start, event trigger +.. _first_event_trigger: + Setting up your first event trigger =================================== diff --git a/docs/graphql/manual/getting-started/first-graphql-query.rst b/docs/graphql/manual/getting-started/first-graphql-query.rst index c5049988023b4..4d38d02378849 100644 --- a/docs/graphql/manual/getting-started/first-graphql-query.rst +++ b/docs/graphql/manual/getting-started/first-graphql-query.rst @@ -4,6 +4,8 @@ .. _first_graphql_query: +.. _first_graphql_query: + Making your first GraphQL query =============================== diff --git a/docs/graphql/manual/getting-started/heroku-simple.rst b/docs/graphql/manual/getting-started/heroku-simple.rst index 69650cc6ea43b..ffcf00801806c 100644 --- a/docs/graphql/manual/getting-started/heroku-simple.rst +++ b/docs/graphql/manual/getting-started/heroku-simple.rst @@ -2,6 +2,8 @@ :description: Get started with Hasura using Heroku :keywords: hasura, docs, start, heroku +.. _heroku_simple: + Quickstart with Heroku ====================== diff --git a/docs/graphql/manual/getting-started/index.rst b/docs/graphql/manual/getting-started/index.rst index d6ebb8ca9a416..cda82c57032df 100644 --- a/docs/graphql/manual/getting-started/index.rst +++ b/docs/graphql/manual/getting-started/index.rst @@ -2,6 +2,8 @@ :description: Get started with Hasura :keywords: hasura, docs, start +.. _getting_started: + Getting started =============== diff --git a/docs/graphql/manual/getting-started/using-existing-database.rst b/docs/graphql/manual/getting-started/using-existing-database.rst index 81b623b19a39a..d40ca11ef68fc 100644 --- a/docs/graphql/manual/getting-started/using-existing-database.rst +++ b/docs/graphql/manual/getting-started/using-existing-database.rst @@ -2,6 +2,8 @@ :description: Get started with Hasura using an existing database :keywords: hasura, docs, start, existing database +.. _using_existing_database: + Getting started with an existing database ========================================= diff --git a/docs/graphql/manual/guides/auditing-tables.rst b/docs/graphql/manual/guides/auditing-tables.rst index 4f670992ca141..672c8c5bf21da 100644 --- a/docs/graphql/manual/guides/auditing-tables.rst +++ b/docs/graphql/manual/guides/auditing-tables.rst @@ -2,6 +2,8 @@ :description: Audit actions on tables in Postgres with Hasura :keywords: hasura, docs, guide, postgres, audit table +.. _guides_auditing: + Auditing actions on tables in Postgres ====================================== diff --git a/docs/graphql/manual/guides/code-editor-integrations/index.rst b/docs/graphql/manual/guides/code-editor-integrations/index.rst index 3a9552b1062d0..eb4e12329e418 100644 --- a/docs/graphql/manual/guides/code-editor-integrations/index.rst +++ b/docs/graphql/manual/guides/code-editor-integrations/index.rst @@ -2,6 +2,8 @@ :description: Guides for code editor integrations with Hasura :keywords: hasura, docs, guide, code editor, integration +.. _guides_code_editor_integrations: + Guides: Code Editor Integrations ================================ diff --git a/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst b/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst index 546d28e4f4549..ffd39dacb22f9 100644 --- a/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst +++ b/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst @@ -2,6 +2,8 @@ :description: Visual studio code integration with Hasura :keywords: hasura, docs, guide, code editor, integration, visual studio code, vs code +.. _vs_code: + Guides: Visual Studio Code Setup ================================ diff --git a/docs/graphql/manual/guides/data-modelling/index.rst b/docs/graphql/manual/guides/data-modelling/index.rst index 6191aadbcb2be..32de7b7acc540 100644 --- a/docs/graphql/manual/guides/data-modelling/index.rst +++ b/docs/graphql/manual/guides/data-modelling/index.rst @@ -2,6 +2,8 @@ :description: Guides for data modelling with Hasura :keywords: hasura, docs, guide, data modelling +.. _guides_data_modelling: + Guides: Data modelling ====================== diff --git a/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst b/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst index d43998791786f..13d124adbbe58 100644 --- a/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst +++ b/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine One-click App on DigitalOcean Marketplace :keywords: hasura, docs, guide, deployment, digital ocean, marketplace +.. _deploy_do_marketplace: + Hasura GraphQL engine One-click App on DigitalOcean Marketplace =============================================================== diff --git a/docs/graphql/manual/guides/deployment/google-kubernetes-engine-cloud-sql.rst b/docs/graphql/manual/guides/deployment/google-kubernetes-engine-cloud-sql.rst index cb250065bb798..cacc3c61e1639 100644 --- a/docs/graphql/manual/guides/deployment/google-kubernetes-engine-cloud-sql.rst +++ b/docs/graphql/manual/guides/deployment/google-kubernetes-engine-cloud-sql.rst @@ -2,6 +2,8 @@ :description: Deploy Hasura GraphQL engine on Google Cloud Platform with Kubernetes engine and Cloud SQL :keywords: hasura, docs, guide, deployment, google cloud, kubernetes, cloud sql +.. _deploy_gc_kubernetes: + Hasura GraphQL engine on Google Cloud Platform with Kubernetes engine and Cloud SQL =================================================================================== diff --git a/docs/graphql/manual/guides/deployment/index.rst b/docs/graphql/manual/guides/deployment/index.rst index 82ef6df793f60..1257b31d25dca 100644 --- a/docs/graphql/manual/guides/deployment/index.rst +++ b/docs/graphql/manual/guides/deployment/index.rst @@ -2,6 +2,8 @@ :description: Guides for deploying Hasura :keywords: hasura, docs, guide, deployment +.. _guides_deployment: + Guides: Deployment ================== diff --git a/docs/graphql/manual/guides/index.rst b/docs/graphql/manual/guides/index.rst index 8d5046f6c8d3e..937384caa071b 100644 --- a/docs/graphql/manual/guides/index.rst +++ b/docs/graphql/manual/guides/index.rst @@ -2,6 +2,8 @@ :description: Guides, Tutorials and Resources around using Hasura :keywords: hasura, docs, guide, tutorial, resource +.. _guides: + Guides / Tutorials / Resources ============================== diff --git a/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst b/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst index 26f619dda487e..f89cad7ea3cff 100644 --- a/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst +++ b/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst @@ -2,6 +2,8 @@ :description: Set up GraphQL subscriptions with apollo-client :keywords: hasura, docs, guide, GraphQL subscriptions, apollo, apollo-client +.. _apollo_subscriptions: + Setting up GraphQL subscriptions using apollo-client ==================================================== diff --git a/docs/graphql/manual/guides/integrations/index.rst b/docs/graphql/manual/guides/integrations/index.rst index ac80ccd0d2422..0bee6c4d167bd 100644 --- a/docs/graphql/manual/guides/integrations/index.rst +++ b/docs/graphql/manual/guides/integrations/index.rst @@ -2,6 +2,8 @@ :description: Integration and migration tutorials for Hasura :keywords: hasura, docs, integration, migration +.. _guides_integrations_migrations: + Guides: Integration/migration tutorials ======================================= diff --git a/docs/graphql/manual/guides/monitoring/index.rst b/docs/graphql/manual/guides/monitoring/index.rst index 8d956e4da0946..869302f09c1a7 100644 --- a/docs/graphql/manual/guides/monitoring/index.rst +++ b/docs/graphql/manual/guides/monitoring/index.rst @@ -2,6 +2,8 @@ :description: Guides for integrating Hasura with monitoring frameworks :keywords: hasura, docs, integration, monitoring, monitoring framework +.. _guides_monitoring_frameworks: + Guides: Integrating with monitoring frameworks ============================================== diff --git a/docs/graphql/manual/guides/sample-apps/index.rst b/docs/graphql/manual/guides/sample-apps/index.rst index 857b7fcdb83e3..510f5ad5aeb61 100644 --- a/docs/graphql/manual/guides/sample-apps/index.rst +++ b/docs/graphql/manual/guides/sample-apps/index.rst @@ -2,6 +2,8 @@ :description: Sample apps and boilerplates using Hasura :keywords: hasura, docs, sample app, boilerplate +.. _sample_apps: + Sample apps & boilerplates ========================== diff --git a/docs/graphql/manual/how-it-works/index.rst b/docs/graphql/manual/how-it-works/index.rst index c6fe4c0913957..d635254d90aed 100644 --- a/docs/graphql/manual/how-it-works/index.rst +++ b/docs/graphql/manual/how-it-works/index.rst @@ -2,6 +2,8 @@ :description: How Hasura GraphQL engine works :keywords: hasura, docs, graphql engine, how it works +.. _how_it_works: + How Hasura GraphQL engine works =============================== diff --git a/docs/graphql/manual/migrations/advanced/index.rst b/docs/graphql/manual/migrations/advanced/index.rst index 61f8c7be1b87f..d58d1d82b7eae 100644 --- a/docs/graphql/manual/migrations/advanced/index.rst +++ b/docs/graphql/manual/migrations/advanced/index.rst @@ -2,6 +2,8 @@ :description: Examples for advanced Hasura migration use cases :keywords: hasura, docs, migration, advanced, use case +.. _migrations_advanced: + Migrations advanced use cases ============================= diff --git a/docs/graphql/manual/migrations/advanced/rolling-back-migrations.rst b/docs/graphql/manual/migrations/advanced/rolling-back-migrations.rst index 303a5eb01f556..0b76efdd10f43 100644 --- a/docs/graphql/manual/migrations/advanced/rolling-back-migrations.rst +++ b/docs/graphql/manual/migrations/advanced/rolling-back-migrations.rst @@ -2,6 +2,8 @@ :description: Roll back Hasura migrations :keywords: hasura, docs, migration, roll back +.. _roll_back_migrations: + Rolling back applied migrations =============================== diff --git a/docs/graphql/manual/migrations/advanced/seed-data-migration.rst b/docs/graphql/manual/migrations/advanced/seed-data-migration.rst index bbda9bef0c757..6d2026cdb982c 100644 --- a/docs/graphql/manual/migrations/advanced/seed-data-migration.rst +++ b/docs/graphql/manual/migrations/advanced/seed-data-migration.rst @@ -2,6 +2,8 @@ :description: Create a seed data migration in Hasura :keywords: hasura, docs, migration, seed data +.. _seed_data_migration: + Creating a seed data migration ============================== diff --git a/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst b/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst index b32902096adc7..88173644deff8 100644 --- a/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst +++ b/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst @@ -2,6 +2,8 @@ :description: Write manual migrations for Hasura GraphQL engine :keywords: hasura, docs, migration, manual +.. _manual_migrations: + Writing migrations manually =========================== diff --git a/docs/graphql/manual/migrations/existing-database.rst b/docs/graphql/manual/migrations/existing-database.rst index 9115e1212a61a..176979472a727 100644 --- a/docs/graphql/manual/migrations/existing-database.rst +++ b/docs/graphql/manual/migrations/existing-database.rst @@ -2,6 +2,8 @@ :description: Manage migrations on an existing database and Hasura instance :keywords: hasura, docs, migration, existing database +.. _migrations_existing_db: + Migrations for an existing database and Hasura instance ======================================================= diff --git a/docs/graphql/manual/migrations/new-database.rst b/docs/graphql/manual/migrations/new-database.rst index 9575daece2d8c..939055491a051 100644 --- a/docs/graphql/manual/migrations/new-database.rst +++ b/docs/graphql/manual/migrations/new-database.rst @@ -2,6 +2,8 @@ :description: Manage migrations on a new database and Hasura instance :keywords: hasura, docs, migration, new database +.. _migrations_new_db: + Migrations for a new database and Hasura instance ================================================= diff --git a/docs/graphql/manual/migrations/reference/how-it-works.rst b/docs/graphql/manual/migrations/reference/how-it-works.rst index 2bc8d7196fdfd..c863b4045f2cf 100644 --- a/docs/graphql/manual/migrations/reference/how-it-works.rst +++ b/docs/graphql/manual/migrations/reference/how-it-works.rst @@ -2,6 +2,8 @@ :description: How Hasura migrations work :keywords: hasura, docs, migration, how it works +.. _migrations_how_to: + How Hasura migrations work ========================== diff --git a/docs/graphql/manual/migrations/reference/index.rst b/docs/graphql/manual/migrations/reference/index.rst index 167f15b8731c8..bff8082fe8eab 100644 --- a/docs/graphql/manual/migrations/reference/index.rst +++ b/docs/graphql/manual/migrations/reference/index.rst @@ -2,6 +2,8 @@ :description: Migrations reference documentation :keywords: hasura, docs, migration, reference +.. _migration_reference: + Migrations reference documentation ================================== diff --git a/docs/graphql/manual/mutations/delete.rst b/docs/graphql/manual/mutations/delete.rst index 257731da14f7f..cad3882d9b84b 100644 --- a/docs/graphql/manual/mutations/delete.rst +++ b/docs/graphql/manual/mutations/delete.rst @@ -2,6 +2,8 @@ :description: Delete an object from the database using a mutation :keywords: hasura, docs, mutation, delete +.. _delete: + Delete mutation =============== diff --git a/docs/graphql/manual/mutations/index.rst b/docs/graphql/manual/mutations/index.rst index da8ed4e9c6906..d52b688a6a082 100644 --- a/docs/graphql/manual/mutations/index.rst +++ b/docs/graphql/manual/mutations/index.rst @@ -2,6 +2,8 @@ :description: Manage mutations with Hasura :keywords: hasura, docs, mutation +.. _mutations: + Mutations ========= diff --git a/docs/graphql/manual/mutations/insert.rst b/docs/graphql/manual/mutations/insert.rst index 8798ebe07f83f..ae5576bfa4d38 100644 --- a/docs/graphql/manual/mutations/insert.rst +++ b/docs/graphql/manual/mutations/insert.rst @@ -2,6 +2,8 @@ :description: Insert an object into the database using a mutation :keywords: hasura, docs, mutation, insert +.. _insert: + Insert mutation =============== diff --git a/docs/graphql/manual/mutations/multiple-mutations.rst b/docs/graphql/manual/mutations/multiple-mutations.rst index 591e63f8339ba..6ae90febfc6b7 100644 --- a/docs/graphql/manual/mutations/multiple-mutations.rst +++ b/docs/graphql/manual/mutations/multiple-mutations.rst @@ -2,6 +2,8 @@ :description: Run multiple mutations in a request in Hasura :keywords: hasura, docs, mutation, multiple mutations, request +.. _multiple_mutations: + Multiple mutations in a request =============================== diff --git a/docs/graphql/manual/mutations/update.rst b/docs/graphql/manual/mutations/update.rst index e6989a6a2fbc0..0b0c85f69e471 100644 --- a/docs/graphql/manual/mutations/update.rst +++ b/docs/graphql/manual/mutations/update.rst @@ -2,6 +2,8 @@ :description: Update an object in the database using a mutation :keywords: hasura, docs, mutation, update +.. _update: + Update mutation =============== diff --git a/docs/graphql/manual/mutations/upsert.rst b/docs/graphql/manual/mutations/upsert.rst index b75acdce70041..4a66d2ddd8a52 100644 --- a/docs/graphql/manual/mutations/upsert.rst +++ b/docs/graphql/manual/mutations/upsert.rst @@ -2,6 +2,8 @@ :description: Use upsert mutations with Hasura :keywords: hasura, docs, mutation, upsert +.. _upsert: + Upsert mutation =============== diff --git a/docs/graphql/manual/queries/aggregation-queries.rst b/docs/graphql/manual/queries/aggregation-queries.rst index a0e30c0350610..a29841079f4d2 100644 --- a/docs/graphql/manual/queries/aggregation-queries.rst +++ b/docs/graphql/manual/queries/aggregation-queries.rst @@ -2,6 +2,8 @@ :description: Make aggregation queries with Hasura :keywords: hasura, docs, query, aggregation query +.. _aggregation_queries: + Aggregation queries =================== diff --git a/docs/graphql/manual/queries/distinct-queries.rst b/docs/graphql/manual/queries/distinct-queries.rst index 3e34bc1955e64..1018599c7e5bb 100644 --- a/docs/graphql/manual/queries/distinct-queries.rst +++ b/docs/graphql/manual/queries/distinct-queries.rst @@ -2,6 +2,8 @@ :description: Make distinct queries with Hasura :keywords: hasura, docs, query, distinct query +.. _distinct_queries: + Distinct query results ====================== diff --git a/docs/graphql/manual/queries/index.rst b/docs/graphql/manual/queries/index.rst index a215b56b4bd13..c2722ca4b2bcc 100644 --- a/docs/graphql/manual/queries/index.rst +++ b/docs/graphql/manual/queries/index.rst @@ -2,6 +2,8 @@ :description: Manage queries with Hasura :keywords: hasura, docs, query +.. _queries: + Queries ======= diff --git a/docs/graphql/manual/queries/multiple-arguments.rst b/docs/graphql/manual/queries/multiple-arguments.rst index 88fe105580155..ab4e4a103cf9f 100644 --- a/docs/graphql/manual/queries/multiple-arguments.rst +++ b/docs/graphql/manual/queries/multiple-arguments.rst @@ -2,6 +2,8 @@ :description: Use multiple arguments in a query in Hasura :keywords: hasura, docs, query, multiple arguments +.. _multiple_arguments: + Using multiple arguments in a query =================================== diff --git a/docs/graphql/manual/queries/multiple-queries.rst b/docs/graphql/manual/queries/multiple-queries.rst index 31f1b0dd91a2c..95dfcccf684f7 100644 --- a/docs/graphql/manual/queries/multiple-queries.rst +++ b/docs/graphql/manual/queries/multiple-queries.rst @@ -2,6 +2,8 @@ :description: Run multiple queries in a request in Hasura :keywords: hasura, docs, query, multiple queries, request +.. _multiple_queries: + Multiple queries in a request ============================= diff --git a/docs/graphql/manual/queries/nested-object-queries.rst b/docs/graphql/manual/queries/nested-object-queries.rst index 39d21e6b8229f..208227471abd2 100644 --- a/docs/graphql/manual/queries/nested-object-queries.rst +++ b/docs/graphql/manual/queries/nested-object-queries.rst @@ -2,6 +2,8 @@ :description: Make nested object queries in Hasura :keywords: hasura, docs, query, nested object query +.. _nested_object_queries: + Nested object queries ===================== diff --git a/docs/graphql/manual/queries/pagination.rst b/docs/graphql/manual/queries/pagination.rst index e9eadc4f510af..c7ac5f702281f 100644 --- a/docs/graphql/manual/queries/pagination.rst +++ b/docs/graphql/manual/queries/pagination.rst @@ -2,6 +2,8 @@ :description: Manage pagination with Hasura :keywords: hasura, docs, query, pagination +.. _pagination: + Paginate query results ====================== diff --git a/docs/graphql/manual/queries/query-filters.rst b/docs/graphql/manual/queries/query-filters.rst index 5024c8d0beb80..12bce60ec3865 100644 --- a/docs/graphql/manual/queries/query-filters.rst +++ b/docs/graphql/manual/queries/query-filters.rst @@ -2,6 +2,8 @@ :description: Filter query results and search queries in Hasura :keywords: hasura, docs, query, filter, search +.. _filter_queries: + Filter query results / search queries ===================================== diff --git a/docs/graphql/manual/queries/simple-object-queries.rst b/docs/graphql/manual/queries/simple-object-queries.rst index 2ac134f8ed6af..ed4bfe343f106 100644 --- a/docs/graphql/manual/queries/simple-object-queries.rst +++ b/docs/graphql/manual/queries/simple-object-queries.rst @@ -2,6 +2,8 @@ :description: Make simple object queries in Hasura :keywords: hasura, docs, query, object query +.. _simple_object_queries: + Simple object queries ===================== diff --git a/docs/graphql/manual/queries/sorting.rst b/docs/graphql/manual/queries/sorting.rst index 57ab91376dadc..c5a3ccf18711c 100644 --- a/docs/graphql/manual/queries/sorting.rst +++ b/docs/graphql/manual/queries/sorting.rst @@ -2,6 +2,8 @@ :description: Sort query results in Hasura :keywords: hasura, docs, query, sort +.. _sort_query_results: + Sort query results ================== diff --git a/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst b/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst index aeeac9d6b6fd3..e817b7fb104ec 100644 --- a/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst +++ b/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst @@ -2,6 +2,8 @@ :description: Use variables, aliases, fragments and directives in Hasura queries :keywords: hasura, docs, query, variable, alias, fragment, directive +.. _variables_aliases: + Using variables / aliases / fragments / directives in queries ============================================================= diff --git a/docs/graphql/manual/remote-schemas/index.rst b/docs/graphql/manual/remote-schemas/index.rst index 1fe1953582c8d..1b5cfe30c3c04 100644 --- a/docs/graphql/manual/remote-schemas/index.rst +++ b/docs/graphql/manual/remote-schemas/index.rst @@ -2,6 +2,8 @@ :description: Manage remote schemas with Hasura :keywords: hasura, docs, remote schema +.. _remote_schemas: + Remote schemas ============== diff --git a/docs/graphql/manual/schema/basics.rst b/docs/graphql/manual/schema/basics.rst index ea84afd6da116..79297e4800728 100644 --- a/docs/graphql/manual/schema/basics.rst +++ b/docs/graphql/manual/schema/basics.rst @@ -2,6 +2,8 @@ :description: Schema design basics in Hasura :keywords: hasura, docs, schema, basics +.. _schema_basics: + Schema design basics ==================== diff --git a/docs/graphql/manual/schema/computed-fields.rst b/docs/graphql/manual/schema/computed-fields.rst index 0c8823b68d7bb..38327081e0b96 100644 --- a/docs/graphql/manual/schema/computed-fields.rst +++ b/docs/graphql/manual/schema/computed-fields.rst @@ -2,6 +2,8 @@ :description: Use computed fields in Hasura :keywords: hasura, docs, schema, computed field +.. _computed_fields: + Computed fields =============== diff --git a/docs/graphql/manual/schema/default-values/column-presets.rst b/docs/graphql/manual/schema/default-values/column-presets.rst index b1dd0d94e6c10..59d6f02994062 100644 --- a/docs/graphql/manual/schema/default-values/column-presets.rst +++ b/docs/graphql/manual/schema/default-values/column-presets.rst @@ -2,6 +2,8 @@ :description: Set default field values using role-based column presets :keywords: hasura, docs, schema, default value, role-based, column preset +.. _column_presets: + Setting default values for fields using role-based column presets ================================================================= diff --git a/docs/graphql/manual/schema/default-values/index.rst b/docs/graphql/manual/schema/default-values/index.rst index c173011cc15e5..2568855f150bc 100644 --- a/docs/graphql/manual/schema/default-values/index.rst +++ b/docs/graphql/manual/schema/default-values/index.rst @@ -2,6 +2,8 @@ :description: Set default field values in Hasura :keywords: hasura, docs, schema, default value +.. _default_values: + Setting default values for fields ================================= diff --git a/docs/graphql/manual/schema/default-values/postgres-defaults.rst b/docs/graphql/manual/schema/default-values/postgres-defaults.rst index 9ff1a49c2577b..5af13b7ca294a 100644 --- a/docs/graphql/manual/schema/default-values/postgres-defaults.rst +++ b/docs/graphql/manual/schema/default-values/postgres-defaults.rst @@ -2,6 +2,8 @@ :description: Set default field values using Postgres defaults :keywords: hasura, docs, schema, default value, Postgres default +.. _postgres_defaults: + Setting default values for fields using Postgres defaults ========================================================= diff --git a/docs/graphql/manual/schema/default-values/sql-functions.rst b/docs/graphql/manual/schema/default-values/sql-functions.rst index 06448fd5099f8..9338b72addcd4 100644 --- a/docs/graphql/manual/schema/default-values/sql-functions.rst +++ b/docs/graphql/manual/schema/default-values/sql-functions.rst @@ -2,6 +2,8 @@ :description: Set default field values using SQL functions :keywords: hasura, docs, schema, default value, sql function, stored procedure +.. _sql_functions: + Setting values of fields using SQL functions/stored procedures ============================================================== diff --git a/docs/graphql/manual/schema/enums.rst b/docs/graphql/manual/schema/enums.rst index 8d93c9dd194aa..a1f48fdc3f98b 100644 --- a/docs/graphql/manual/schema/enums.rst +++ b/docs/graphql/manual/schema/enums.rst @@ -2,6 +2,8 @@ :description: Use enums in Hasura :keywords: hasura, docs, schema, enum +.. _enums: + Enum type fields ================ diff --git a/docs/graphql/manual/schema/export-graphql-schema.rst b/docs/graphql/manual/schema/export-graphql-schema.rst index f23d8c813e5c1..1b6db1630320e 100644 --- a/docs/graphql/manual/schema/export-graphql-schema.rst +++ b/docs/graphql/manual/schema/export-graphql-schema.rst @@ -2,6 +2,8 @@ :description: Export the GraphQL schema in Hasura :keywords: hasura, docs, schema, graphql schema, export +.. _export_graphql_schema: + Exporting the Hasura GraphQL schema =================================== diff --git a/docs/graphql/manual/schema/index.rst b/docs/graphql/manual/schema/index.rst index 3326ec9aaf667..d465829c28560 100644 --- a/docs/graphql/manual/schema/index.rst +++ b/docs/graphql/manual/schema/index.rst @@ -2,6 +2,8 @@ :description: Manage GraphQL schema with Hasura :keywords: hasura, docs, schema +.. _schema: + Schema ====== diff --git a/docs/graphql/manual/schema/relationships/create.rst b/docs/graphql/manual/schema/relationships/create.rst index 610ff5db94216..5116820a330e1 100644 --- a/docs/graphql/manual/schema/relationships/create.rst +++ b/docs/graphql/manual/schema/relationships/create.rst @@ -2,6 +2,8 @@ :description: Create relationships in Hasura :keywords: hasura, docs, schema, relationship, create +.. _create_relationships: + Creating relationships ====================== diff --git a/docs/graphql/manual/schema/relationships/database-modelling/index.rst b/docs/graphql/manual/schema/relationships/database-modelling/index.rst index 0f537b1cd5b58..cc2ec84db5672 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/index.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/index.rst @@ -2,6 +2,8 @@ :description: Relationships modelling in Hasura :keywords: hasura, docs, schema, database modelling +.. _database_modelling: + Database modelling guides ========================= diff --git a/docs/graphql/manual/schema/relationships/index.rst b/docs/graphql/manual/schema/relationships/index.rst index 0b37dc80f1d85..f9b2f39c57e65 100644 --- a/docs/graphql/manual/schema/relationships/index.rst +++ b/docs/graphql/manual/schema/relationships/index.rst @@ -2,7 +2,6 @@ :description: Manage relationships between tables/views in Hasura :keywords: hasura, docs, schema, relationship - .. _relationships: Relationships between tables/views diff --git a/docs/graphql/manual/schema/relationships/rename.rst b/docs/graphql/manual/schema/relationships/rename.rst index fea3572131ed4..cda3906b88433 100644 --- a/docs/graphql/manual/schema/relationships/rename.rst +++ b/docs/graphql/manual/schema/relationships/rename.rst @@ -2,6 +2,8 @@ :description: Rename relationships in Hasura :keywords: hasura, docs, schema, relationship, rename +.. _rename_relationships: + Renaming relationships ====================== diff --git a/docs/graphql/manual/schema/using-existing-database.rst b/docs/graphql/manual/schema/using-existing-database.rst index 4bebd4e1097fc..08d0c76fc40aa 100644 --- a/docs/graphql/manual/schema/using-existing-database.rst +++ b/docs/graphql/manual/schema/using-existing-database.rst @@ -2,6 +2,8 @@ :description: Set up a Hasura GraphQL schema with an existing database :keywords: hasura, docs, schema, existing database +.. _schema_existing_db: + Setting up a GraphQL schema using an existing database ====================================================== diff --git a/docs/graphql/manual/security-disclosure/index.rst b/docs/graphql/manual/security-disclosure/index.rst index 443e3f186f97e..2daf06f16500e 100644 --- a/docs/graphql/manual/security-disclosure/index.rst +++ b/docs/graphql/manual/security-disclosure/index.rst @@ -2,6 +2,8 @@ :description: Hasura security vulnerability reporting and disclosure :keywords: hasura, docs, security, security disclosure, vulnerability +.. _security_vulnerability: + Security vulnerability reporting and disclosure =============================================== diff --git a/docs/graphql/manual/subscriptions/index.rst b/docs/graphql/manual/subscriptions/index.rst index 346dadabeadfc..df303f76a7ee7 100644 --- a/docs/graphql/manual/subscriptions/index.rst +++ b/docs/graphql/manual/subscriptions/index.rst @@ -2,6 +2,8 @@ :description: Manage subscriptions with Hasura :keywords: hasura, docs, subscription +.. _subscriptions: + Subscriptions ============= diff --git a/docs/graphql/manual/subscriptions/use-cases.rst b/docs/graphql/manual/subscriptions/use-cases.rst index 8dc47eadec889..1fedb6ce003c8 100644 --- a/docs/graphql/manual/subscriptions/use-cases.rst +++ b/docs/graphql/manual/subscriptions/use-cases.rst @@ -2,6 +2,8 @@ :description: Use cases for Hasura subscriptions :keywords: hasura, docs, subscription, use case +.. _subscription_cases: + Subscriptions sample use cases ============================== diff --git a/docs/graphql/manual/troubleshooting/index.rst b/docs/graphql/manual/troubleshooting/index.rst index cab19315a304a..86dce1c0b2859 100644 --- a/docs/graphql/manual/troubleshooting/index.rst +++ b/docs/graphql/manual/troubleshooting/index.rst @@ -2,6 +2,8 @@ :description: Troubleshoot Hasura GraphQL engine errors :keywords: hasura, docs, error, troubleshooting +.. _troubleshooting: + Troubleshooting Hasura GraphQL engine errors ============================================ From ba18f2016442ec7a6d72d061aeb3dc933ebda19c Mon Sep 17 00:00:00 2001 From: Marion Schleifer Date: Mon, 9 Mar 2020 12:59:15 +0100 Subject: [PATCH 2/4] replace :doc: with :ref: --- docs/graphql/manual/actions/index.rst | 6 +- docs/graphql/manual/api-reference/config.rst | 2 +- docs/graphql/manual/api-reference/explain.rst | 2 +- .../api-reference/graphql-api/index.rst | 6 +- .../api-reference/graphql-api/mutation.rst | 2 +- .../api-reference/graphql-api/query.rst | 2 +- docs/graphql/manual/api-reference/index.rst | 16 ++--- docs/graphql/manual/api-reference/pgdump.rst | 2 +- .../schema-metadata-api/actions.rst | 2 +- .../schema-metadata-api/custom-types.rst | 2 +- .../schema-metadata-api/index.rst | 26 +++---- .../manual/auth/authentication/jwt.rst | 4 +- .../authentication/unauthenticated-access.rst | 8 +-- .../manual/auth/authentication/webhook.rst | 6 +- .../manual/auth/authorization/basics.rst | 12 ++-- .../common-roles-auth-examples.rst | 14 ++-- .../manual/auth/authorization/index.rst | 4 +- .../auth/authorization/permission-rules.rst | 10 +-- docs/graphql/manual/deployment/allow-list.rst | 6 +- .../manual/deployment/docker/index.rst | 14 ++-- .../manual/deployment/docker/logging.rst | 2 +- .../docker/securing-graphql-endpoint.rst | 2 +- .../manual/deployment/docker/updating.rst | 2 +- .../graphql/manual/deployment/downgrading.rst | 6 +- .../deployment/graphql-engine-flags/index.rst | 2 +- .../manual/deployment/heroku/index.rst | 18 ++--- .../manual/deployment/heroku/logging.rst | 2 +- .../heroku/securing-graphql-endpoint.rst | 2 +- .../manual/deployment/heroku/updating.rst | 2 +- .../heroku/using-existing-heroku-database.rst | 4 +- docs/graphql/manual/deployment/index.rst | 18 ++--- .../manual/deployment/kubernetes/index.rst | 14 ++-- .../manual/deployment/kubernetes/logging.rst | 2 +- .../kubernetes/securing-graphql-endpoint.rst | 2 +- .../manual/deployment/kubernetes/updating.rst | 2 +- docs/graphql/manual/deployment/logging.rst | 12 ++-- .../deployment/securing-graphql-endpoint.rst | 8 +-- docs/graphql/manual/deployment/updating.rst | 6 +- .../event-triggers/invoke-trigger-console.rst | 2 +- .../manual/event-triggers/serverless.rst | 4 +- .../manual/getting-started/docker-simple.rst | 10 +-- .../getting-started/first-event-trigger.rst | 2 +- .../getting-started/first-graphql-query.rst | 6 +- .../manual/getting-started/heroku-simple.rst | 8 +-- docs/graphql/manual/getting-started/index.rst | 10 +-- .../using-existing-database.rst | 6 +- .../guides/code-editor-integrations/index.rst | 2 +- .../guides/data-modelling/soft-deletes.rst | 4 +- .../deployment/digital-ocean-one-click.rst | 2 +- .../manual/guides/deployment/index.rst | 8 +-- .../manual/guides/integrations/auth0-jwt.rst | 2 +- .../guides/integrations/aws-cognito.rst | 2 +- .../manual/guides/integrations/index.rst | 8 +-- docs/graphql/manual/hasura-cli/index.rst | 70 +++++++++---------- .../hasura-cli/uninstall-hasura-cli.rst | 2 + docs/graphql/manual/how-it-works/index.rst | 2 +- .../advanced/writing-migrations-manually.rst | 2 +- .../manual/migrations/existing-database.rst | 2 +- docs/graphql/manual/migrations/index.rst | 20 +++--- .../manual/migrations/manage-metadata.rst | 14 ++-- .../manual/migrations/manage-migrations.rst | 4 +- .../manual/migrations/new-database.rst | 2 +- .../migrations/reference/how-it-works.rst | 4 +- .../reference/metadata-file-format.rst | 12 ++-- docs/graphql/manual/mutations/delete.rst | 2 +- docs/graphql/manual/mutations/insert.rst | 4 +- docs/graphql/manual/mutations/update.rst | 2 +- docs/graphql/manual/mutations/upsert.rst | 2 +- .../manual/queries/distinct-queries.rst | 2 +- docs/graphql/manual/queries/index.rst | 2 +- .../manual/queries/nested-object-queries.rst | 2 +- docs/graphql/manual/queries/pagination.rst | 2 +- docs/graphql/manual/remote-schemas/index.rst | 8 +-- docs/graphql/manual/schema/basics.rst | 2 +- .../graphql/manual/schema/computed-fields.rst | 6 +- .../manual/schema/custom-functions.rst | 2 +- .../schema/default-values/column-presets.rst | 6 +- .../manual/schema/default-values/index.rst | 8 +-- .../default-values/postgres-defaults.rst | 4 +- .../schema/default-values/sql-functions.rst | 4 +- docs/graphql/manual/schema/enums.rst | 2 +- docs/graphql/manual/schema/index.rst | 2 +- .../database-modelling/index.rst | 6 +- .../database-modelling/many-to-many.rst | 6 +- .../database-modelling/one-to-many.rst | 2 +- .../database-modelling/one-to-one.rst | 2 +- .../manual/schema/relationships/index.rst | 12 ++-- .../manual/schema/using-existing-database.rst | 8 +-- docs/graphql/manual/subscriptions/index.rst | 6 +- .../manual/subscriptions/use-cases.rst | 2 +- docs/graphql/manual/troubleshooting/index.rst | 2 +- 91 files changed, 285 insertions(+), 285 deletions(-) diff --git a/docs/graphql/manual/actions/index.rst b/docs/graphql/manual/actions/index.rst index 6f80d99bce2e5..1ea67b629428e 100644 --- a/docs/graphql/manual/actions/index.rst +++ b/docs/graphql/manual/actions/index.rst @@ -76,7 +76,7 @@ custom types like so: userId: Int! } -Read more about :doc:`custom types`. +Read more about :ref:`custom types`. Handler ******* @@ -86,7 +86,7 @@ when the action mutation is executed. This can be done in an HTTP webhook, also called the action handler. It could be a REST endpoint or a serverless function. -Learn more about :doc:`writing an action handler`. +Learn more about :ref:`writing an action handler`. Kind **** @@ -95,7 +95,7 @@ Actions are of two kinds: * **Synchronous actions**: Sync actions return a response to the client after receiving a response from the handler. -* **Asynchronous actions**: :doc:`Async actions ` return an +* **Asynchronous actions**: :ref:`Async actions ` return an ``action id`` as response to the client before receiving a response from the handler and allow the client to subscribe to the actual response using the ``action id``. diff --git a/docs/graphql/manual/api-reference/config.rst b/docs/graphql/manual/api-reference/config.rst index eeb352f1d64b3..4a7fb0239d608 100644 --- a/docs/graphql/manual/api-reference/config.rst +++ b/docs/graphql/manual/api-reference/config.rst @@ -66,4 +66,4 @@ the list of enabled APIs. --enabled-apis="graphql,metadata" HASURA_GRAPHQL_ENABLED_APIS="graphql,metadata" -See :doc:`../deployment/graphql-engine-flags/reference` for info on setting the above flag/env var. +See :ref:`server_flag_reference` for info on setting the above flag/env var. diff --git a/docs/graphql/manual/api-reference/explain.rst b/docs/graphql/manual/api-reference/explain.rst index 0c2769c1a916d..93b845cfadf13 100644 --- a/docs/graphql/manual/api-reference/explain.rst +++ b/docs/graphql/manual/api-reference/explain.rst @@ -118,4 +118,4 @@ Sample response for a subscription Disabling Explain API --------------------- -The Explain API is part of the :doc:`Metadata API ` and can only be disabled by disabling the same. +The Explain API is part of the :ref:`Metadata API ` and can only be disabled by disabling the same. diff --git a/docs/graphql/manual/api-reference/graphql-api/index.rst b/docs/graphql/manual/api-reference/graphql-api/index.rst index 5665f005e0306..f53e8a72075f1 100644 --- a/docs/graphql/manual/api-reference/graphql-api/index.rst +++ b/docs/graphql/manual/api-reference/graphql-api/index.rst @@ -2,7 +2,7 @@ :description: Hasura GraphQL API reference :keywords: hasura, docs, GraphQL API, reference -.. _graphql_api: +.. _api_reference_graphql: GraphQL API Reference ===================== @@ -31,8 +31,8 @@ Request types The following types of requests can be made using the GraphQL API: -- :doc:`Query / Subscription ` -- :doc:`Mutation ` +- :ref:`Query / Subscription ` +- :ref:`Mutation ` Batching operations ------------------- diff --git a/docs/graphql/manual/api-reference/graphql-api/mutation.rst b/docs/graphql/manual/api-reference/graphql-api/mutation.rst index 6e644b526140d..ca1040ecda0ad 100644 --- a/docs/graphql/manual/api-reference/graphql-api/mutation.rst +++ b/docs/graphql/manual/api-reference/graphql-api/mutation.rst @@ -294,7 +294,7 @@ Delete syntax .. note:: - For more examples and details of usage, please see :doc:`this <../../mutations/index>`. + For more examples and details of usage, please see :ref:`this `. Syntax definitions ------------------ diff --git a/docs/graphql/manual/api-reference/graphql-api/query.rst b/docs/graphql/manual/api-reference/graphql-api/query.rst index d72f60cdc2c60..1828938571011 100644 --- a/docs/graphql/manual/api-reference/graphql-api/query.rst +++ b/docs/graphql/manual/api-reference/graphql-api/query.rst @@ -67,7 +67,7 @@ Query / subscription syntax .. note:: - For more examples and details of usage, please see :doc:`this <../../queries/index>`. + For more examples and details of usage, please see :ref:`this `. Syntax definitions ------------------ diff --git a/docs/graphql/manual/api-reference/index.rst b/docs/graphql/manual/api-reference/index.rst index 78a0a43ff75e7..92cea58cea148 100644 --- a/docs/graphql/manual/api-reference/index.rst +++ b/docs/graphql/manual/api-reference/index.rst @@ -42,7 +42,7 @@ GraphQL API All GraphQL requests for queries, subscriptions and mutations are made to the GraphQL API. -See details at :doc:`graphql-api/index`. +See details at :ref:`api_reference_graphql`. .. _schema_metadata_api: @@ -54,7 +54,7 @@ executing SQL on the underlying Postgres. This is primarily intended to be used as an ``admin`` API to manage the Hasura schema and metadata. -See details at :doc:`schema-metadata-api/index`. +See details at :ref:`metadata_apis`. .. _version_api: @@ -63,7 +63,7 @@ Version API The ``/v1/version`` is a public endpoint that responds with the current server version in JSON format. -See details at :doc:`version`. +See details at :ref:`version_api_reference`. .. _health_api: @@ -72,7 +72,7 @@ Health check API The ``/healthz`` is a public endpoint that returns the server health status. -See details at :doc:`health`. +See details at :ref:`health_api_reference`. .. _pg_dump_api: @@ -84,7 +84,7 @@ The ``/v1alpha1/pg_dump`` is an admin-only endpoint that can be used to execute tool's argument can be passed as a POST request body to the API and the response is sent back to the client. -See details at :doc:`pgdump`. +See details at :ref:`pg_dump_api_reference`. .. _config_api: @@ -94,7 +94,7 @@ Config API ``v1alpha1/config`` is an admin-only endpoint to get the current server configuration. -See details at :doc:`config`. +See details at :ref:`config_api_reference`. .. _explain_api: @@ -104,13 +104,13 @@ Explain API ``v1/graphql/explain`` returns the Postgres plan for a query or subscription based on the defined permissions. -See details at :doc:`explain`. +See details at :ref:`explain_api_reference`. Supported PostgreSQL types -------------------------- You can refer to the following to know about all PostgreSQL types supported by the Hasura GraphQL engine: -- :doc:`Supported PostgreSQL types ` +- :ref:`Supported PostgreSQL types ` .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/api-reference/pgdump.rst b/docs/graphql/manual/api-reference/pgdump.rst index c19248223c21a..abe85f53bf5b0 100644 --- a/docs/graphql/manual/api-reference/pgdump.rst +++ b/docs/graphql/manual/api-reference/pgdump.rst @@ -96,4 +96,4 @@ state that this API is not enabled. i.e. remove it from the list of enabled APIs --enabled-apis="graphql,metadata" HASURA_GRAPHQL_ENABLED_APIS="graphql,metadata" -See :doc:`../deployment/graphql-engine-flags/reference` for info on setting the above flag/env var. +See :ref:`server_flag_reference` for info on setting the above flag/env var. diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst b/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst index 46a7c848b02bf..901431f8df926 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/actions.rst @@ -138,7 +138,7 @@ InputArgument .. note:: - The ``GraphQL Types`` used in creating an action must be defined before via :doc:`Custom Types ` + The ``GraphQL Types`` used in creating an action must be defined before via :ref:`Custom Types ` .. _drop_action: diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst b/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst index 2d09bbc279c78..1ef0790c4c575 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/custom-types.rst @@ -7,7 +7,7 @@ Schema/Metadata API Reference: Custom Types =========================================== -**Custom Types** are user-defined GraphQL types which help to define :doc:`Actions `. +**Custom Types** are user-defined GraphQL types which help to define :ref:`Actions `. .. _set_custom_types: diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/index.rst b/docs/graphql/manual/api-reference/schema-metadata-api/index.rst index ce30129cb5a3c..df95332905256 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/index.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/index.rst @@ -328,18 +328,18 @@ The various types of queries are listed in the following table: **See:** -- :doc:`Run SQL ` -- :doc:`Tables/Views ` -- :doc:`Custom SQL Functions ` -- :doc:`Relationships ` -- :doc:`Computed Fields ` -- :doc:`Permissions ` -- :doc:`Event Triggers ` -- :doc:`Remote Schemas ` -- :doc:`Query Collections ` -- :doc:`Custom Types ` -- :doc:`Actions ` -- :doc:`Manage Metadata ` +- :ref:`Run SQL ` +- :ref:`Tables/Views ` +- :ref:`Custom SQL Functions ` +- :ref:`Relationships ` +- :ref:`Computed Fields ` +- :ref:`Permissions ` +- :ref:`Event Triggers ` +- :ref:`Remote Schemas ` +- :ref:`Query Collections ` +- :ref:`Custom Types ` +- :ref:`Actions ` +- :ref:`Manage Metadata ` Response structure ------------------ @@ -408,7 +408,7 @@ to explicitly state that this API is not enabled i.e. remove it from the list of --enabled-apis="graphql" HASURA_GRAPHQL_ENABLED_APIS="graphql" -See :doc:`../../deployment/graphql-engine-flags/reference` for info on setting the above flag/env var. +See :ref:`server_flag_reference` for info on setting the above flag/env var. .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/auth/authentication/jwt.rst b/docs/graphql/manual/auth/authentication/jwt.rst index 823ada07961f8..ce682c5c5d7e5 100644 --- a/docs/graphql/manual/auth/authentication/jwt.rst +++ b/docs/graphql/manual/auth/authentication/jwt.rst @@ -32,7 +32,7 @@ are used for the permissions system. .. admonition:: Prerequisite - It is mandatory to first :doc:`secure your GraphQL endpoint <../../deployment/securing-graphql-endpoint>` for the JWT mode to take effect. + It is mandatory to first :ref:`secure your GraphQL endpoint ` for the JWT mode to take effect. In JWT mode, on a secured endpoint: @@ -458,7 +458,7 @@ If you are using Firebase and Hasura, use this config: Auth0 ^^^^^ -Refer the :doc:`Auth0 JWT Integration guide <../../guides/integrations/auth0-jwt>` for a full integration guide +Refer the :ref:`Auth0 JWT Integration guide ` for a full integration guide with Auth0. Auth0 publishes their JWK under: diff --git a/docs/graphql/manual/auth/authentication/unauthenticated-access.rst b/docs/graphql/manual/auth/authentication/unauthenticated-access.rst index a5ac4126a7ffa..e4660af63225c 100644 --- a/docs/graphql/manual/auth/authentication/unauthenticated-access.rst +++ b/docs/graphql/manual/auth/authentication/unauthenticated-access.rst @@ -25,10 +25,10 @@ Configuring unauthenticated access ---------------------------------- You can use the env variable ``HASURA_GRAPHQL_UNAUTHORIZED_ROLE`` or ``--unauthorized-role`` flag to set a role -for unauthenticated (non-logged in) users. See :doc:`../../deployment/graphql-engine-flags/reference` for more details +for unauthenticated (non-logged in) users. See :ref:`server_flag_reference` for more details on setting this flag/env var. -This role can then be used to define the permissions for unauthenticated users as described in :doc:`../authorization/index`. +This role can then be used to define the permissions for unauthenticated users as described in :ref:`authorization`. A guide on setting up unauthenticated user permissions can be found :ref:`here `. How it works @@ -39,8 +39,8 @@ receives. Based on your authentication setup, an unauthenticated request is any request: -- for which the webhook returns a ``401 Unauthorized`` response in case of :doc:`webhook authentication <./webhook>`. -- which does not contain a JWT token in case of :doc:`JWT authentication <./jwt>`. +- for which the webhook returns a ``401 Unauthorized`` response in case of :ref:`webhook authentication `. +- which does not contain a JWT token in case of :ref:`JWT authentication `. Once an unauthenticated role is configured, unaunthenticated requests will not be rejected and instead the request will be made with the configured role. diff --git a/docs/graphql/manual/auth/authentication/webhook.rst b/docs/graphql/manual/auth/authentication/webhook.rst index 9cc7079361d52..65352170388d5 100644 --- a/docs/graphql/manual/auth/authentication/webhook.rst +++ b/docs/graphql/manual/auth/authentication/webhook.rst @@ -22,7 +22,7 @@ You can configure the GraphQL engine to use a webhook to authenticate all incomi .. admonition:: Prerequisite - It is mandatory to first :doc:`secure your GraphQL endpoint <../../deployment/securing-graphql-endpoint>` for the webhook mode to take effect. + It is mandatory to first :ref:`secure your GraphQL endpoint ` for the webhook mode to take effect. In webhook mode, on a secured endpoint: @@ -33,9 +33,9 @@ In webhook mode, on a secured endpoint: Configuring webhook mode ------------------------ -* You can configure Hasura to run in webhook mode by running the GraphQL engine with the ``--auth-hook`` flag or the ``HASURA_GRAPHQL_AUTH_HOOK`` environment variable (see :doc:`GraphQL engine server options <../../deployment/graphql-engine-flags/reference>`), the value of which is the webhook endpoint. +* You can configure Hasura to run in webhook mode by running the GraphQL engine with the ``--auth-hook`` flag or the ``HASURA_GRAPHQL_AUTH_HOOK`` environment variable (see :ref:`GraphQL engine server options `), the value of which is the webhook endpoint. -* You can configure Hasura to send either a ``GET`` or a ``POST`` request to your auth webhook. The default configuration is ``GET`` and you can override this with ``POST`` by using the ``--auth-hook-mode`` flag or the ``HASURA_GRAPHQL_AUTH_HOOK_MODE`` environment variable (*in addition to those specified above; see* :doc:`GraphQL engine server options <../../deployment/graphql-engine-flags/reference>`). +* You can configure Hasura to send either a ``GET`` or a ``POST`` request to your auth webhook. The default configuration is ``GET`` and you can override this with ``POST`` by using the ``--auth-hook-mode`` flag or the ``HASURA_GRAPHQL_AUTH_HOOK_MODE`` environment variable (*in addition to those specified above; see* :ref:`GraphQL engine server options `). Spec for the webhook -------------------- diff --git a/docs/graphql/manual/auth/authorization/basics.rst b/docs/graphql/manual/auth/authorization/basics.rst index 67d9f43318a65..29c1f94b2255e 100644 --- a/docs/graphql/manual/auth/authorization/basics.rst +++ b/docs/graphql/manual/auth/authorization/basics.rst @@ -30,7 +30,7 @@ combination of **role**, **table** and **action** (*insert, update, select and d Limit access to a subset of the rows in the table based on this permission. Row-level permissions are essentially boolean expressions that, when evaluated against any row, determine access to it. These -permissions are constructed from the values in columns, :doc:`session variables ` and +permissions are constructed from the values in columns, :ref:`session variables ` and static values to build this boolean expression. **Column-level permissions** @@ -40,7 +40,7 @@ this permission rule. .. admonition:: More information - For details on all the configuration options, see :doc:`permission-rules`. + For details on all the configuration options, see :ref:`permission_rules`. Example @@ -111,13 +111,13 @@ As you can see, the results are now filtered based on the access control rule fo restricted to only those rows where the value in the ``id`` column is equal to ``1`` (*as indicated by the* ``X-Hasura-User-ID`` *session variable*). -As described in the :doc:`Introduction to Authentication and Authorization ` section of the docs, +As described in the :ref:`Introduction to Authentication and Authorization ` section of the docs, your auth service is required to resolve authentication tokens into these session variables. See -:doc:`Reference - Session Variables` for more details. +:ref:`Reference - Session Variables` for more details. Next steps ---------- -Read about roles and session variables at: :doc:`roles-variables` +Read about roles and session variables at: :ref:`roles_variables` -See more detailed examples at: :doc:`Common access control examples` +See more detailed examples at: :ref:`Common access control examples` diff --git a/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst b/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst index d40d603fb8c98..9769d42e6adf7 100644 --- a/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst +++ b/docs/graphql/manual/auth/authorization/common-roles-auth-examples.rst @@ -13,7 +13,7 @@ Access control examples :local: This is a guide to help you set up a basic authorization architecture for your GraphQL fields. It is recommended -that you first check out :doc:`roles-variables` and :doc:`permission-rules` +that you first check out :ref:`roles_variables` and :ref:`permission_rules` that will be referred to throughout this guide. Here are some examples of common use cases. @@ -35,7 +35,7 @@ Anonymous (not logged in) users :class: no-shadow :alt: Access control for an anonymous role -See :doc:`../authentication/unauthenticated-access` for steps to configure the anonymous user role in Hasura. +See :ref:`unauthenticated_access` for steps to configure the anonymous user role in Hasura. Logged-in users --------------- @@ -44,8 +44,8 @@ Logged-in users - Access control rules in this case are usually dependent on a ``user_id`` or a ``owner_id`` column in your data model. - Set up a permission for insert/select/update/delete that uses said column. E.g.: ``author_id: {_eq: "X-Hasura-User-Id"}`` for an article table. -- Note that the ``X-Hasura-User-Id`` is a :doc:`dynamic session variable<./roles-variables>` that comes in from - your :doc:`auth webhook's <../authentication/webhook>` response, or as a request header if you're testing. +- Note that the ``X-Hasura-User-Id`` is a :ref:`dynamic session variable` that comes in from + your :ref:`auth webhook's ` response, or as a request header if you're testing. .. thumbnail:: ../../../../img/graphql/manual/auth/user-select-graphiql.png :class: no-shadow @@ -61,8 +61,8 @@ organisation either in the same table or via a related table. - Create a role called ``manager``. - Create a permission for select, which has the condition: ``org_id: {_eq: "X-Hasura-Org-Id"}``. -- ``X-Hasura-Org-Id`` is a :doc:`dynamic variable <./roles-variables>` that is returned by your - :doc:`auth webhook <../authentication/webhook>` for an incoming GraphQL request. +- ``X-Hasura-Org-Id`` is a :ref:`dynamic variable ` that is returned by your + :ref:`auth webhook ` for an incoming GraphQL request. .. thumbnail:: ../../../../img/graphql/manual/auth/org-manager-graphiql.png :class: no-shadow @@ -238,7 +238,7 @@ Permissions for role ``author`` a) :ref:`Column-level permissions`: Restrict access to certain columns only. - b) :doc:`Column presets <../../schema/default-values/column-presets>`: Session-variable-based column preset for the ``author_id`` column to automatically insert the user's ID i.e. the ``X-Hasura-User-Id`` session-variable's value. It also helps us avoid explicitly passing the user's ID in the insert mutation. + b) :ref:`Column presets `: Session-variable-based column preset for the ``author_id`` column to automatically insert the user's ID i.e. the ``X-Hasura-User-Id`` session-variable's value. It also helps us avoid explicitly passing the user's ID in the insert mutation. .. thumbnail:: ../../../../img/graphql/manual/auth/multirole-example-author-insert.png :alt: Permissions for the role author diff --git a/docs/graphql/manual/auth/authorization/index.rst b/docs/graphql/manual/auth/authorization/index.rst index ff252bde23d71..d0c9bc3d99746 100644 --- a/docs/graphql/manual/auth/authorization/index.rst +++ b/docs/graphql/manual/auth/authorization/index.rst @@ -17,7 +17,7 @@ Overview Hasura supports **role-based** authorization where access control is done by creating rules for each role, table and operation (*insert*, *update*, etc.). These access control rules use dynamic session -variables that are passed to the GraphQL engine from your :doc:`authentication service <../authentication/index>` +variables that are passed to the GraphQL engine from your :ref:`authentication service ` with every request. Role information is inferred from the ``X-Hasura-Role`` and ``X-Hasura-Allowed-Roles`` session variables. Other session variables can be passed by your auth service as per your requirements. @@ -39,7 +39,7 @@ auth service with GraphQL engine. You can just: request headers (*send a* ``X-Hasura-Role`` *key, with its value as the name of the role you've defined rules for*). The data in the response will be restricted as per your configuration. -Follow the example at :doc:`access control basics `. +Follow the example at :ref:`access control basics `. **See:** diff --git a/docs/graphql/manual/auth/authorization/permission-rules.rst b/docs/graphql/manual/auth/authorization/permission-rules.rst index dcbb6710d8311..bfc5666fd5b3c 100644 --- a/docs/graphql/manual/auth/authorization/permission-rules.rst +++ b/docs/graphql/manual/auth/authorization/permission-rules.rst @@ -34,7 +34,7 @@ constraints on the data being returned or modified. Let's take a look at the different configuration options available to define a permission rule. Permission rules are defined for each role, table, operation (*insert, select, update, delete*) by using the console -or the :doc:`metadata APIs for permissions <../../api-reference/schema-metadata-api/permission>`. +or the :ref:`metadata APIs for permissions `. Operation permissions --------------------- @@ -97,7 +97,7 @@ Using column operators to build rules ************************************* Type-based operators (*depending on the column type*) are available for constructing row-level permissions. -You can use the same operators that you use to :doc:`filter query results <../../queries/query-filters>` +You can use the same operators that you use to :ref:`filter query results ` along with a few others to define permission rules. See the :ref:`API reference ` for a list of all supported column operators. @@ -154,7 +154,7 @@ the author's ID*): Using relationships or nested objects ************************************* -You can leverage :doc:`relationships <../../schema/relationships/index>` to define permission rules with fields +You can leverage :ref:`relationships ` to define permission rules with fields from a nested object. **For example**, let's say you have an object relationship called ``agent`` from the ``authors`` table to another table @@ -227,7 +227,7 @@ In the above example, this configuration restricts the number of accessible row Aggregation queries permissions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In the case of ``select`` operations, access to :doc:`aggregation queries <../../queries/aggregation-queries>` +In the case of ``select`` operations, access to :ref:`aggregation queries ` can be restricted for a given role using this configuration. .. thumbnail:: ../../../../img/graphql/manual/auth/aggregation-query-permissions.png @@ -241,7 +241,7 @@ Column presets ^^^^^^^^^^^^^^ While this is strictly not a permission configuration, defining -:doc:`role-based column presets <../../schema/default-values/column-presets>` on any column automatically +:ref:`role-based column presets ` on any column automatically removes access to it. This preset can be defined for ``insert`` and ``update`` operations. This configuration is also very useful to avoid sending sensitive user-information in the query and leverage session variables or static data instead. diff --git a/docs/graphql/manual/deployment/allow-list.rst b/docs/graphql/manual/deployment/allow-list.rst index 91c0003ac73bc..74e41915e8883 100644 --- a/docs/graphql/manual/deployment/allow-list.rst +++ b/docs/graphql/manual/deployment/allow-list.rst @@ -42,7 +42,7 @@ You can add or remove a query in the allow-list in two ways: to add multiple queries to the allow-list (each query needs to have a name). * **Using metadata APIs:** Queries can be stored in collections and a collection can be added to or removed - from the allow-list. See :doc:`Collections & Allow-list APIs<../api-reference/schema-metadata-api/query-collections>` + from the allow-list. See :ref:`Collections & Allow-list APIs` for API reference. .. note:: @@ -67,7 +67,7 @@ You can add or remove a query in the allow-list in two ways: } * The allow-list is stored in the metadata. To version control the state of the list, you are required to export - the metadata. See :doc:`Managing Hasura metadata <../migrations/manage-metadata>` for more details. + the metadata. See :ref:`Managing Hasura metadata ` for more details. * You can modify the allow-list without actually enabling it on your instance. @@ -77,7 +77,7 @@ Enable allow-list The allow-list validation can be enabled by setting the ``HASURA_GRAPHQL_ENABLE_ALLOWLIST`` environment variable to ``true`` or running the GraphQL engine with the ``--enable-allowlist`` flag (*default value is* -``false``). See :ref:`reference docs `. +``false``). See :ref:`reference docs `. .. note:: diff --git a/docs/graphql/manual/deployment/docker/index.rst b/docs/graphql/manual/deployment/docker/index.rst index 1338f86f7e0f2..26c68ee5a7233 100644 --- a/docs/graphql/manual/deployment/docker/index.rst +++ b/docs/graphql/manual/deployment/docker/index.rst @@ -66,11 +66,11 @@ Examples of ``HASURA_GRAPHQL_DATABASE_URL``: - If your **password contains special characters** (e.g. #, %, $, @, etc.), you need to URL encode them in the ``HASURA_GRAPHQL_DATABASE_URL`` env var (e.g. %40 for @). - You can check the :doc:`logs ` to see if the database credentials are proper and if Hasura is able + You can check the :ref:`logs ` to see if the database credentials are proper and if Hasura is able to connect to the database. - Hasura GraphQL engine needs access permissions to your Postgres database as described in - :doc:`Postgres permissions <../postgres-permissions>`. + :ref:`Postgres permissions `. Network config ^^^^^^^^^^^^^^ @@ -145,15 +145,15 @@ Head to http://localhost:8080/console to open the Hasura console. Step 5: Track existing tables and relationships ----------------------------------------------- -See :doc:`../../schema/using-existing-database` to enable GraphQL over the database. +See :ref:`schema_existing_db` to enable GraphQL over the database. Advanced -------- -- :doc:`Securing your GraphQL endpoint ` -- :doc:`GraphQL engine server logs ` -- :doc:`Updating GraphQL engine ` -- :doc:`Setting up migrations <../../migrations/index>` +- :ref:`Securing your GraphQL endpoint ` +- :ref:`GraphQL engine server logs ` +- :ref:`Updating GraphQL engine ` +- :ref:`Setting up migrations ` .. toctree:: :titlesonly: diff --git a/docs/graphql/manual/deployment/docker/logging.rst b/docs/graphql/manual/deployment/docker/logging.rst index b3e4aac28e136..dcee4e250e86f 100644 --- a/docs/graphql/manual/deployment/docker/logging.rst +++ b/docs/graphql/manual/deployment/docker/logging.rst @@ -31,4 +31,4 @@ GraphQL engine container: - https://docs.docker.com/config/containers/logging for more details on logging in Docker. -- :doc:`../logging` for more details on Hasura logs. +- :ref:`hge_logs` for more details on Hasura logs. diff --git a/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst index 9ad7bb8860581..db633c76a95e1 100644 --- a/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/docker/securing-graphql-endpoint.rst @@ -32,5 +32,5 @@ Run the Docker command with an admin-secret env var .. note:: The ``HASURA_GRAPHQL_ADMIN_SECRET`` should never be passed from the client to the Hasura GraphQL engine as it would - give the client full admin rights to your Hasura instance. See :doc:`../../auth/index` for information on + give the client full admin rights to your Hasura instance. See :ref:`auth` for information on setting up authentication. diff --git a/docs/graphql/manual/deployment/docker/updating.rst b/docs/graphql/manual/deployment/docker/updating.rst index 9b5172b4baa2f..11bbb8096b19f 100644 --- a/docs/graphql/manual/deployment/docker/updating.rst +++ b/docs/graphql/manual/deployment/docker/updating.rst @@ -47,4 +47,4 @@ you should change it to: .. note:: If you are downgrading to an older version of the GraphQL engine you might need to downgrade your metadata catalogue version - as described in :doc:`../downgrading` + as described in :ref:`downgrade_hge` diff --git a/docs/graphql/manual/deployment/downgrading.rst b/docs/graphql/manual/deployment/downgrading.rst index 5dc8d3ca3f45e..3b5092bd9a58b 100644 --- a/docs/graphql/manual/deployment/downgrading.rst +++ b/docs/graphql/manual/deployment/downgrading.rst @@ -22,9 +22,9 @@ as changing the image tag to the version you want. Based on your deployment method, follow the appropriate guide to downgrade the GraphQL engine version you're running: -- :doc:`Updating on Heroku ` -- :doc:`Updating on Docker ` -- :doc:`Updating on Kubernetes ` +- :ref:`Updating on Heroku ` +- :ref:`Updating on Docker ` +- :ref:`Updating on Kubernetes ` If the GraphQL engine version you are downgrading to has a different catalogue version than your current, you will have to downgrade the catalogue diff --git a/docs/graphql/manual/deployment/graphql-engine-flags/index.rst b/docs/graphql/manual/deployment/graphql-engine-flags/index.rst index 5a8ad22b1d749..3ecc099bafa5e 100644 --- a/docs/graphql/manual/deployment/graphql-engine-flags/index.rst +++ b/docs/graphql/manual/deployment/graphql-engine-flags/index.rst @@ -17,7 +17,7 @@ Hasura supports various flags and options for customising how you are running th Server flags ------------ -See the :doc:`server flag reference ` for all the available flags. +See the :ref:`server flag reference ` for all the available flags. Use cases --------- diff --git a/docs/graphql/manual/deployment/heroku/index.rst b/docs/graphql/manual/deployment/heroku/index.rst index 843df5e2a4746..067d6426860dd 100644 --- a/docs/graphql/manual/deployment/heroku/index.rst +++ b/docs/graphql/manual/deployment/heroku/index.rst @@ -14,8 +14,8 @@ Run Hasura GraphQL engine on Heroku This guide will help you get the Hasura GraphQL engine running as a "git push to deploy" app on `Heroku `_ and connecting it to a `Heroku Postgres `_ -instance. If you want a simple, quick deployment on Heroku, follow this :doc:`Heroku quickstart -guide <../../getting-started/heroku-simple>`. +instance. If you want a simple, quick deployment on Heroku, follow this :ref:`Heroku quickstart +guide `. Clone the Hasura GraphQL engine Heroku app ------------------------------------------ @@ -43,12 +43,12 @@ By default, it connects to the primary database in your app which is available a --server-port $PORT \ --enable-console -Read about more configuration options :doc:`here <../graphql-engine-flags/reference>`. +Read about more configuration options :ref:`here `. .. note:: Hasura GraphQL engine needs access permissions to your Postgres database as described in - :doc:`Postgres permissions <../postgres-permissions>`. + :ref:`Postgres permissions `. Deploying @@ -109,11 +109,11 @@ you should see the Hasura console. Advanced -------- -- :doc:`Securing your GraphQL endpoint ` -- :doc:`using-existing-heroku-database` -- :doc:`GraphQL engine server logs ` -- :doc:`Updating GraphQL engine ` -- :doc:`Setting up migrations <../../migrations/index>` +- :ref:`Securing your GraphQL endpoint ` +- :ref:`heroku_existing_db` +- :ref:`GraphQL engine server logs ` +- :ref:`Updating GraphQL engine ` +- :ref:`Setting up migrations ` .. toctree:: :titlesonly: diff --git a/docs/graphql/manual/deployment/heroku/logging.rst b/docs/graphql/manual/deployment/heroku/logging.rst index fdfd4f7f76c45..e2c4a7f16e953 100644 --- a/docs/graphql/manual/deployment/heroku/logging.rst +++ b/docs/graphql/manual/deployment/heroku/logging.rst @@ -26,4 +26,4 @@ of the Hasura GraphQL engine deployed on Heroku: - https://devcenter.heroku.com/articles/logging for more details on logging on Heroku. -- :doc:`../logging` for more details on Hasura logs +- :ref:`hge_logs` for more details on Hasura logs diff --git a/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst index 347d5f235b107..3e9cf8912f942 100644 --- a/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/heroku/securing-graphql-endpoint.rst @@ -33,7 +33,7 @@ prompted for the admin secret key. .. note:: The ``HASURA_GRAPHQL_ADMIN_SECRET`` should never be passed from the client to Hasura GraphQL engine as it would - give the client full admin rights to your Hasura instance. See :doc:`../../auth/index` for information on + give the client full admin rights to your Hasura instance. See :ref:`auth` for information on setting up authentication. diff --git a/docs/graphql/manual/deployment/heroku/updating.rst b/docs/graphql/manual/deployment/heroku/updating.rst index ff00dc70f71eb..65fb0fc913dd4 100644 --- a/docs/graphql/manual/deployment/heroku/updating.rst +++ b/docs/graphql/manual/deployment/heroku/updating.rst @@ -83,4 +83,4 @@ Change ``v1.0.0-alpha01`` to ``v1.0.0-alpha02`` for example, and then ``git push .. note:: If you are downgrading to an older version of the GraphQL engine you might need to downgrade your metadata catalogue version - as described in :doc:`../downgrading` + as described in :ref:`downgrade_hge` diff --git a/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst b/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst index 1c7ef91e861ac..87b5d7d026af0 100644 --- a/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst +++ b/docs/graphql/manual/deployment/heroku/using-existing-heroku-database.rst @@ -56,10 +56,10 @@ if you want to secure your endpoint. .. note:: The Hasura GraphQL engine needs access permissions to your Postgres database as described in - :doc:`Postgres permissions <../postgres-permissions>`. + :ref:`Postgres permissions `. Step 4: Track tables and relationships -------------------------------------- -Wait for the GraphQL engine to restart and then see :doc:`../../schema/using-existing-database` to enable GraphQL +Wait for the GraphQL engine to restart and then see :ref:`schema_existing_db` to enable GraphQL over the database. diff --git a/docs/graphql/manual/deployment/index.rst b/docs/graphql/manual/deployment/index.rst index d323379a81563..99aa3da69e511 100644 --- a/docs/graphql/manual/deployment/index.rst +++ b/docs/graphql/manual/deployment/index.rst @@ -15,7 +15,7 @@ Deploying Hasura GraphQL engine .. note:: This section talks in depth about deploying the Hasura GraphQL engine for a **production-like environment**. If you would simply like to take the Hasura GraphQL engine for a quick spin, choose from our - :doc:`Getting started guides <../getting-started/index>`. + :ref:`Getting started guides `. Deployment guides ----------------- @@ -24,11 +24,11 @@ The Hasura GraphQL engine is a binary that is shipped as a Docker container. Choose from the following guides to deploy the Hasura GraphQL engine and connect it to a Postgres database: -- :doc:`Deploy using Heroku ` -- :doc:`Deploy using Docker ` -- :doc:`Deploy using Kubernetes ` +- :ref:`Deploy using Heroku ` +- :ref:`Deploy using Docker ` +- :ref:`Deploy using Kubernetes ` -You can also check :doc:`../guides/deployment/index` for more specific examples. +You can also check :ref:`guides_deployment` for more specific examples. Configuration ------------- @@ -36,16 +36,16 @@ Configuration By default, Hasura GraphQL engine runs in a very permissive mode for easier development. Check out the below pages to configure the Hasura GraphQL engine for your production environment: -- :doc:`securing-graphql-endpoint` -- :doc:`postgres-permissions` -- :doc:`GraphQL engine server configuration ` +- :ref:`securing_graphql_endpoint` +- :ref:`postgres_permissions` +- :ref:`GraphQL engine server configuration ` Logs ---- For access to Hasura GraphQL engine logs, check the below page for details: -- :doc:`Logging ` +- :ref:`Logging ` .. toctree:: diff --git a/docs/graphql/manual/deployment/kubernetes/index.rst b/docs/graphql/manual/deployment/kubernetes/index.rst index 16c4f80ece1d7..c226d48f5cd9b 100644 --- a/docs/graphql/manual/deployment/kubernetes/index.rst +++ b/docs/graphql/manual/deployment/kubernetes/index.rst @@ -52,11 +52,11 @@ Examples of ``HASURA_GRAPHQL_DATABASE_URL``: - If your **password contains special characters** (e.g. #, %, $, @, etc.), you need to URL encode them in the ``HASURA_GRAPHQL_DATABASE_URL`` env var (e.g. %40 for @). - You can check the :doc:`logs ` to see if the database credentials are proper and if Hasura is able + You can check the :ref:`logs ` to see if the database credentials are proper and if Hasura is able to connect to the database. - The Hasura GraphQL engine needs access permissions on your Postgres database as described in - :doc:`Postgres permissions <../postgres-permissions>`. + :ref:`Postgres permissions `. Step 3: Create the Kubernetes deployment and service @@ -87,15 +87,15 @@ Head to: http://localhost and the console should load! Step 5: Track existing tables and relationships ----------------------------------------------- -See :doc:`../../schema/using-existing-database` to enable GraphQL over the database. +See :ref:`schema_existing_db` to enable GraphQL over the database. Advanced -------- -- :doc:`Securing your GraphQL endpoint ` -- :doc:`GraphQL engine server logs ` -- :doc:`Updating GraphQL engine ` -- :doc:`Setting up migrations <../../migrations/index>` +- :ref:`Securing your GraphQL endpoint ` +- :ref:`GraphQL engine server logs ` +- :ref:`Updating GraphQL engine ` +- :ref:`Setting up migrations ` .. toctree:: :titlesonly: diff --git a/docs/graphql/manual/deployment/kubernetes/logging.rst b/docs/graphql/manual/deployment/kubernetes/logging.rst index 6bccf44d705a6..d0c0f03638676 100644 --- a/docs/graphql/manual/deployment/kubernetes/logging.rst +++ b/docs/graphql/manual/deployment/kubernetes/logging.rst @@ -27,4 +27,4 @@ service, i.e. ``hasura``: - https://kubernetes.io/docs/concepts/cluster-administration/logging for more details on logging in Kubernetes. -- :doc:`../logging` for more details on Hasura logs +- :ref:`hge_logs` for more details on Hasura logs diff --git a/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst index 38c7309ccf838..da18f2a567819 100644 --- a/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/kubernetes/securing-graphql-endpoint.rst @@ -43,7 +43,7 @@ Update the ``deployment.yaml`` to set the ``HASURA_GRAPHQL_ADMIN_SECRET`` enviro .. note:: The ``HASURA_GRAPHQL_ADMIN_SECRET`` should never be passed from the client to the Hasura GraphQL engine as it would - give the client full admin rights to your Hasura instance. See :doc:`../../auth/index` for information on + give the client full admin rights to your Hasura instance. See :ref:`auth` for information on setting up authentication. diff --git a/docs/graphql/manual/deployment/kubernetes/updating.rst b/docs/graphql/manual/deployment/kubernetes/updating.rst index e379c936b026f..b40caa332dfe1 100644 --- a/docs/graphql/manual/deployment/kubernetes/updating.rst +++ b/docs/graphql/manual/deployment/kubernetes/updating.rst @@ -60,7 +60,7 @@ Step 3: Rollout the change .. note:: If you are downgrading to an older version of the GraphQL engine you might need to downgrade your metadata catalogue version - as described in :doc:`../downgrading` + as described in :ref:`downgrade_hge` diff --git a/docs/graphql/manual/deployment/logging.rst b/docs/graphql/manual/deployment/logging.rst index 3cb9663a18986..f335807923e19 100644 --- a/docs/graphql/manual/deployment/logging.rst +++ b/docs/graphql/manual/deployment/logging.rst @@ -17,9 +17,9 @@ Accessing logs Based on your deployment method, the Hasura GraphQL engine logs can be accessed as follows: -- :doc:`On Heroku ` -- :doc:`On Docker ` -- :doc:`On Kubernetes ` +- :ref:`On Heroku ` +- :ref:`On Docker ` +- :ref:`On Kubernetes ` .. _log-types: @@ -31,7 +31,7 @@ The Hasura GraphQL engine has different kind of log-types depending on the sub-s For example, the HTTP webserver logs incoming requests as an access log and is called ``http-log``. Similarly logs from the websocket layer are called ``websocket-log``, logs from the event trigger system are called ``event-trigger`` etc. -You can configure the GraphQL engine to enable/disable certain log-types using the the ``--enabled-log-types`` flag or the ``HASURA_GRAPHQL_ENABLED_LOG_TYPES`` env var. See :doc:`../deployment/graphql-engine-flags/reference` +You can configure the GraphQL engine to enable/disable certain log-types using the the ``--enabled-log-types`` flag or the ``HASURA_GRAPHQL_ENABLED_LOG_TYPES`` env var. See :ref:`server_flag_reference` Default enabled log-types are: ``startup, http-log, webhook-log, websocket-log`` @@ -111,7 +111,7 @@ Apart from the above, there are other internal log-types which cannot be configu Logging levels -------------- -You can set the desired logging level on the server using the ``log-level`` flag or the ``HASURA_GRAPHQL_LOG_LEVEL`` env var. See :doc:`../deployment/graphql-engine-flags/reference`. +You can set the desired logging level on the server using the ``log-level`` flag or the ``HASURA_GRAPHQL_LOG_LEVEL`` env var. See :ref:`server_flag_reference`. The default log-level is ``info``. @@ -405,4 +405,4 @@ Monitoring frameworks You can integrate the logs emitted by Hasura GraphQL with external monitoring tools for better visibility as per your convenience. -For some examples, see :doc:`../guides/monitoring/index`. +For some examples, see :ref:`guides_monitoring_frameworks`. diff --git a/docs/graphql/manual/deployment/securing-graphql-endpoint.rst b/docs/graphql/manual/deployment/securing-graphql-endpoint.rst index c6624b9985390..4a56603b1d786 100644 --- a/docs/graphql/manual/deployment/securing-graphql-endpoint.rst +++ b/docs/graphql/manual/deployment/securing-graphql-endpoint.rst @@ -18,12 +18,12 @@ configure an admin secret key. Depending on your deployment method, follow one of these guides to configure an admin secret key, and prevent public access to your GraphQL endpoint and the Hasura console: -- :doc:`For Heroku ` -- :doc:`For Docker ` -- :doc:`For Kubernetes ` +- :ref:`For Heroku ` +- :ref:`For Docker ` +- :ref:`For Kubernetes ` .. note:: If you're looking at adding access control rules for your data to your GraphQL API then head - to :doc:`Authentication / access control <../auth/index>`. + to :ref:`Authentication / access control `. diff --git a/docs/graphql/manual/deployment/updating.rst b/docs/graphql/manual/deployment/updating.rst index 3216757b4d3da..c1cc1a93fd78b 100644 --- a/docs/graphql/manual/deployment/updating.rst +++ b/docs/graphql/manual/deployment/updating.rst @@ -22,6 +22,6 @@ The current latest version is: Based on your deployment method, follow the appropriate guide to update the GraphQL engine version you're running: -- :doc:`Updating on Heroku ` -- :doc:`Updating on Docker ` -- :doc:`Updating on Kubernetes ` +- :ref:`Updating on Heroku ` +- :ref:`Updating on Docker ` +- :ref:`Updating on Kubernetes ` diff --git a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst index 62b337b6566e5..82e909270774b 100644 --- a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst +++ b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst @@ -12,7 +12,7 @@ Invoke event trigger via console :depth: 1 :local: -You can select the ``Via console`` trigger operation while :doc:`creating an event trigger <./create-trigger>` +You can select the ``Via console`` trigger operation while :ref:`creating an event trigger ` to allow invoking the event trigger on rows manually using the Hasura console *(available after version v1.0.0-beta.1)*. In the ``Data -> [table-name] -> Browse Rows`` tab, clicking the ``invoke trigger`` button next to any row lets diff --git a/docs/graphql/manual/event-triggers/serverless.rst b/docs/graphql/manual/event-triggers/serverless.rst index add5159a04377..dbbecaaf4e5eb 100644 --- a/docs/graphql/manual/event-triggers/serverless.rst +++ b/docs/graphql/manual/event-triggers/serverless.rst @@ -60,9 +60,9 @@ Consider the following simplified schema for the above: Whenever an update happens to the ``notes`` table, we want to insert a row into the ``note_revision`` table. -For this we :doc:`setup an event trigger ` on ``UPDATE`` to the ``notes`` table which calls an +For this we :ref:`setup an event trigger ` on ``UPDATE`` to the ``notes`` table which calls an AWS Lambda function. The AWS Lambda function itself uses a GraphQL mutation to insert a new row into the -``note_revision`` table. As the :doc:`event trigger payload ` in case of updates gives us both the old and +``note_revision`` table. As the :ref:`event trigger payload ` in case of updates gives us both the old and the new data, we can store the old note data in our revision table. Our AWS Lambda code looks like this: diff --git a/docs/graphql/manual/getting-started/docker-simple.rst b/docs/graphql/manual/getting-started/docker-simple.rst index 26e014b60d897..15f1fad1db0a0 100644 --- a/docs/graphql/manual/getting-started/docker-simple.rst +++ b/docs/graphql/manual/getting-started/docker-simple.rst @@ -17,8 +17,8 @@ Docker containers using Docker Compose. This is the easiest way to set up Hasura GraphQL engine on your **local environment**. In case you'd like to run Hasura on an existing Postgres database, follow this -guide to :doc:`deploy the Hasura GraphQL engine as a standalone docker container -<../deployment/docker/index>` and connect it to your Postgres instance. +guide to :ref:`deploy the Hasura GraphQL engine as a standalone docker container +` and connect it to your Postgres instance. Prerequisites ------------- @@ -62,16 +62,16 @@ Head to ``http://localhost:8080/console`` to open the Hasura console. Hello World (GraphQL or event triggers) --------------------------------------- -Make your :doc:`first graphql query ` +Make your :ref:`first graphql query ` OR -Set up your :doc:`first event trigger ` +Set up your :ref:`first event trigger ` Advanced -------- This was a quickstart guide to get the Hasura GraphQL engine up and running quickly. For more detailed instructions on deploying using Docker, check out -:doc:`../deployment/docker/index`. +:ref:`deployment_docker`. diff --git a/docs/graphql/manual/getting-started/first-event-trigger.rst b/docs/graphql/manual/getting-started/first-event-trigger.rst index 8466cb2566e4d..73f07e397ea31 100644 --- a/docs/graphql/manual/getting-started/first-event-trigger.rst +++ b/docs/graphql/manual/getting-started/first-event-trigger.rst @@ -62,4 +62,4 @@ Next steps Read more about: -- :doc:`Event triggers <../event-triggers/index>` +- :ref:`Event triggers ` diff --git a/docs/graphql/manual/getting-started/first-graphql-query.rst b/docs/graphql/manual/getting-started/first-graphql-query.rst index 4d38d02378849..8091f28b891b7 100644 --- a/docs/graphql/manual/getting-started/first-graphql-query.rst +++ b/docs/graphql/manual/getting-started/first-graphql-query.rst @@ -4,8 +4,6 @@ .. _first_graphql_query: -.. _first_graphql_query: - Making your first GraphQL query =============================== @@ -58,6 +56,6 @@ Next steps Read more about: -- :doc:`Building your schema <../schema/index>` -- :doc:`Queries <../queries/index>` +- :ref:`Building your schema ` +- :ref:`Queries ` diff --git a/docs/graphql/manual/getting-started/heroku-simple.rst b/docs/graphql/manual/getting-started/heroku-simple.rst index ffcf00801806c..3d29947a6d097 100644 --- a/docs/graphql/manual/getting-started/heroku-simple.rst +++ b/docs/graphql/manual/getting-started/heroku-simple.rst @@ -16,7 +16,7 @@ This guide will help you get the Hasura GraphQL engine and Postgres running on ` It is the easiest and fastest way of trying out Hasura. If you'd like to link this to an existing database, please head to this guide instead: -:doc:`Using an existing database on Heroku <../deployment/heroku/using-existing-heroku-database>`. +:ref:`Using an existing database on Heroku `. Deploy to Heroku ---------------- @@ -50,14 +50,14 @@ You should see the Hasura console. Hello World (GraphQL or event triggers) --------------------------------------- -Make your :doc:`first graphql query ` +Make your :ref:`first graphql query ` OR -Set up your :doc:`first event trigger ` +Set up your :ref:`first event trigger ` Advanced -------- This was a quickstart guide to get the Hasura GraphQL engine up and running quickly. For more detailed instructions -on deploying using Heroku, check out :doc:`../deployment/heroku/index`. +on deploying using Heroku, check out :ref:`deploy_heroku`. diff --git a/docs/graphql/manual/getting-started/index.rst b/docs/graphql/manual/getting-started/index.rst index cda82c57032df..c03cd68bc1ddf 100644 --- a/docs/graphql/manual/getting-started/index.rst +++ b/docs/graphql/manual/getting-started/index.rst @@ -26,19 +26,19 @@ To use the Hasura GraphQL engine, you need to: Get started from scratch ------------------------ -- :doc:`Using Heroku ` **(recommended)**: Get started in under 60 seconds with no setup required to +- :ref:`Using Heroku ` **(recommended)**: Get started in under 60 seconds with no setup required to host the Hasura GraphQL engine and Postgres on Heroku's free tier. -- :doc:`Using Docker `: Run a **local development** setup that sets up both the Hasura GraphQL +- :ref:`Using Docker `: Run a **local development** setup that sets up both the Hasura GraphQL engine and Postgres using Docker. Get started using an existing database -------------------------------------- -- :doc:`Using Heroku <../deployment/heroku/using-existing-heroku-database>`: Run on Heroku using an existing Heroku +- :ref:`Using Heroku `: Run on Heroku using an existing Heroku Postgres database. -- :doc:`Using Docker <../deployment/docker/index>`: Run as a docker container and connect to an existing Postgres +- :ref:`Using Docker `: Run as a docker container and connect to an existing Postgres database. -- :doc:`Using Kubernetes <../deployment/kubernetes/index>`: Run on Kubernetes and connect to an existing Postgres +- :ref:`Using Kubernetes `: Run on Kubernetes and connect to an existing Postgres database. .. admonition:: Supported Postgres versions diff --git a/docs/graphql/manual/getting-started/using-existing-database.rst b/docs/graphql/manual/getting-started/using-existing-database.rst index d40ca11ef68fc..614c61217338b 100644 --- a/docs/graphql/manual/getting-started/using-existing-database.rst +++ b/docs/graphql/manual/getting-started/using-existing-database.rst @@ -14,10 +14,10 @@ Getting started with an existing database Follow one of these guides to set up Hasura GraphQL engine using an existing database: -- :doc:`Using Heroku <../deployment/heroku/using-existing-heroku-database>`: Run on Heroku and connect to an existing +- :ref:`Using Heroku `: Run on Heroku and connect to an existing Heroku Postgres database. -- :doc:`Using Docker <../deployment/docker/index>`: Run as a docker container and connect to an existing Postgres +- :ref:`Using Docker `: Run as a docker container and connect to an existing Postgres database. -- :doc:`Using Kubernetes <../deployment/kubernetes/index>`: Run on Kubernetes and connect to an existing Postgres +- :ref:`Using Kubernetes `: Run on Kubernetes and connect to an existing Postgres database. diff --git a/docs/graphql/manual/guides/code-editor-integrations/index.rst b/docs/graphql/manual/guides/code-editor-integrations/index.rst index eb4e12329e418..b871249a33d1a 100644 --- a/docs/graphql/manual/guides/code-editor-integrations/index.rst +++ b/docs/graphql/manual/guides/code-editor-integrations/index.rst @@ -12,7 +12,7 @@ Guides: Code Editor Integrations :depth: 1 :local: -- :doc:`Visual Studio Code ` +- :ref:`Visual Studio Code ` .. toctree:: diff --git a/docs/graphql/manual/guides/data-modelling/soft-deletes.rst b/docs/graphql/manual/guides/data-modelling/soft-deletes.rst index 912d1648af118..66b66e4f5ad0a 100644 --- a/docs/graphql/manual/guides/data-modelling/soft-deletes.rst +++ b/docs/graphql/manual/guides/data-modelling/soft-deletes.rst @@ -72,7 +72,7 @@ the ``deleted_at`` field to the current timestamp: Step 3: Set up appropriate insert/update/delete permissions ----------------------------------------------------------- -Now, we need to ensure that appropriate :doc:`permissions <../../auth/authorization/index>` are set to avoid +Now, we need to ensure that appropriate :ref:`permissions ` are set to avoid actual deletes from happening and allowing update of the ``deleted_at`` field. Here are some typical rules we should set: @@ -97,7 +97,7 @@ Step 4: Restrict access to soft-deleted records Now that we have set up the soft deleting pattern for records, we need to ensure that we restrict the "deleted" records from being accessed. -We can achieve this by setting appropriate :doc:`permissions <../../auth/authorization/index>` for roles which have +We can achieve this by setting appropriate :ref:`permissions ` for roles which have access to the ``todos`` table. For example, let's say that a role ``user`` can only access non-deleted todos, we need to add the following diff --git a/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst b/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst index 13d124adbbe58..07ad364330dca 100644 --- a/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst +++ b/docs/graphql/manual/guides/deployment/digital-ocean-one-click.rst @@ -303,7 +303,7 @@ database. .. note:: If you're using Hasura with a restricted database user, make sure you go - through :doc:`Postgres permissions <../../deployment/postgres-permissions>` + through :ref:`Postgres permissions ` to configure all required permissions (not applicable with the default connection string with DO Managed Postgres). diff --git a/docs/graphql/manual/guides/deployment/index.rst b/docs/graphql/manual/guides/deployment/index.rst index 1257b31d25dca..1ff78dbbc4787 100644 --- a/docs/graphql/manual/guides/deployment/index.rst +++ b/docs/graphql/manual/guides/deployment/index.rst @@ -12,15 +12,15 @@ Guides: Deployment :depth: 1 :local: -- :doc:`Digital Ocean One-click App on Marketplace ` -- :doc:`Azure Container Instances with Postgres ` -- :doc:`Google Cloud Platform with Kubernetes engine and Cloud SQL ` +- :ref:`Digital Ocean One-click App on Marketplace ` +- :ref:`Azure Container Instances with Postgres ` +- :ref:`Google Cloud Platform with Kubernetes engine and Cloud SQL ` - `Blog: Instant GraphQL on AWS RDS `__ .. note:: The above are guides to deploy the Hasura GraphQL engine on some specific platforms. - For more generic guides, see :doc:`../../deployment/index`. + For more generic guides, see :ref:`deployment`. .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/guides/integrations/auth0-jwt.rst b/docs/graphql/manual/guides/integrations/auth0-jwt.rst index 65872599b12de..9c52b7587acb1 100644 --- a/docs/graphql/manual/guides/integrations/auth0-jwt.rst +++ b/docs/graphql/manual/guides/integrations/auth0-jwt.rst @@ -199,7 +199,7 @@ Add Access Control Rules via Hasura Console Auth0 is configured and ready to be used in the application. You can now set up access control rules that will automatically get applied whenever a client makes a graphql query with the Auth0 token. -Refer to :doc:`../../auth/authorization/basics` for more information. +Refer to :ref:`auth_basics` for more information. To test this out, add an access control rule that uses ``x-hasura-user-id`` for the role ``user``. Then make a GraphQL query or a mutation, with the authorization token from the :ref:`previous step ` diff --git a/docs/graphql/manual/guides/integrations/aws-cognito.rst b/docs/graphql/manual/guides/integrations/aws-cognito.rst index f21138029d6b4..d1ed3a59acc88 100644 --- a/docs/graphql/manual/guides/integrations/aws-cognito.rst +++ b/docs/graphql/manual/guides/integrations/aws-cognito.rst @@ -12,7 +12,7 @@ Using AWS Cognito for authentication :depth: 1 :local: -Cognito can be used in both :doc:`JWT mode <../../auth/authentication/jwt>` and :doc:`webhook mode <../../auth/authentication/webhook>`. +Cognito can be used in both :ref:`JWT mode ` and :ref:`webhook mode `. - For JWT, `this blog post `__ contains detailed instructions. - For webhook, a thin wrapper/webhook that implements `this spec `__ needs to be written. Boilerplates to write this webhook can be found `here `__. diff --git a/docs/graphql/manual/guides/integrations/index.rst b/docs/graphql/manual/guides/integrations/index.rst index 0bee6c4d167bd..4b7f83a79abde 100644 --- a/docs/graphql/manual/guides/integrations/index.rst +++ b/docs/graphql/manual/guides/integrations/index.rst @@ -12,10 +12,10 @@ Guides: Integration/migration tutorials :depth: 1 :local: -- :doc:`auth0-jwt` -- :doc:`auth-guardian-jwt` -- :doc:`aws-cognito` -- :doc:`apollo-subscriptions` +- :ref:`auth0_jwt` +- :ref:`auth_guardian_jwt` +- :ref:`aws_cognito` +- :ref:`apollo_subscriptions` - `Blog: Move from firebase to realtime GraphQL on Postgres `__ - `Blog: Create a Gatsby site using GraphQL on Postgres `__ - `Blog: Instant GraphQL on AWS RDS `__ diff --git a/docs/graphql/manual/hasura-cli/index.rst b/docs/graphql/manual/hasura-cli/index.rst index c566c4ef61a44..34bc5dbe834c5 100644 --- a/docs/graphql/manual/hasura-cli/index.rst +++ b/docs/graphql/manual/hasura-cli/index.rst @@ -21,49 +21,49 @@ The ``Hasura CLI`` is a command line tool which is the primary mode of managing Installation ------------ -Refer to :doc:`install-hasura-cli`. +Refer to :ref:`install_hasura_cli`. Commands -------- -- :doc:`hasura ` -- :doc:`hasura actions ` -- :doc:`hasura actions codegen ` -- :doc:`hasura actions create ` -- :doc:`hasura actions use-codegen ` -- :doc:`hasura completion ` -- :doc:`hasura console ` -- :doc:`hasura init ` -- :doc:`hasura metadata ` -- :doc:`hasura metadata apply ` -- :doc:`hasura metadata clear ` -- :doc:`hasura metadata diff ` -- :doc:`hasura metadata export ` -- :doc:`hasura metadata inconsistency ` -- :doc:`hasura metadata inconsistency drop ` -- :doc:`hasura metadata inconsistency list ` -- :doc:`hasura metadata inconsistency status ` -- :doc:`hasura metadata reload ` -- :doc:`hasura migrate ` -- :doc:`hasura migrate apply ` -- :doc:`hasura migrate create ` -- :doc:`hasura migrate squash ` -- :doc:`hasura migrate status ` -- :doc:`hasura plugins ` -- :doc:`hasura plugins install ` -- :doc:`hasura plugins list ` -- :doc:`hasura plugins uninstall ` -- :doc:`hasura plugins upgrade ` -- :doc:`hasura scripts ` -- :doc:`hasura scripts update-config-v2 ` -- :doc:`hasura update-cli ` -- :doc:`hasura version ` +- :ref:`hasura actions ` +- :ref:`hasura ` +- :ref:`hasura actions codegen ` +- :ref:`hasura actions create ` +- :ref:`hasura actions use-codegen ` +- :ref:`hasura completion ` +- :ref:`hasura console ` +- :ref:`hasura init ` +- :ref:`hasura metadata ` +- :ref:`hasura metadata apply ` +- :ref:`hasura metadata clear ` +- :ref:`hasura metadata diff ` +- :ref:`hasura metadata export ` +- :ref:`hasura metadata inconsistency ` +- :ref:`hasura metadata inconsistency drop ` +- :ref:`hasura metadata inconsistency list ` +- :ref:`hasura metadata inconsistency status ` +- :ref:`hasura metadata reload ` +- :ref:`hasura migrate ` +- :ref:`hasura migrate apply ` +- :ref:`hasura migrate create ` +- :ref:`hasura migrate squash ` +- :ref:`hasura migrate status ` +- :ref:`hasura plugins ` +- :ref:`hasura plugins install ` +- :ref:`hasura plugins list ` +- :ref:`hasura plugins uninstall ` +- :ref:`hasura plugins upgrade ` +- :ref:`hasura scripts ` +- :ref:`hasura scripts update-config-v2 ` +- :ref:`hasura update-cli ` +- :ref:`hasura version ` Uninstalling ------------ -Refer to :doc:`uninstall-hasura-cli`. +Refer to :ref:`uninstall_hasura_cli`. .. toctree:: :maxdepth: 1 @@ -103,4 +103,4 @@ Refer to :doc:`uninstall-hasura-cli`. hasura scripts update-config-v2 hasura update-cli hasura version - uninstall-hasura-cli \ No newline at end of file + uninstall-hasura-cli diff --git a/docs/graphql/manual/hasura-cli/uninstall-hasura-cli.rst b/docs/graphql/manual/hasura-cli/uninstall-hasura-cli.rst index b569209c3dbcc..70fbe523b90ed 100644 --- a/docs/graphql/manual/hasura-cli/uninstall-hasura-cli.rst +++ b/docs/graphql/manual/hasura-cli/uninstall-hasura-cli.rst @@ -2,6 +2,8 @@ :description: Uninstall the Hasura CLI on Linux, Mac OS, Windows :keywords: hasura, hasura CLI, uninstall, linux, mac, windows +.. _uninstall_hasura_cli: + Uninstalling the Hasura CLI =========================== diff --git a/docs/graphql/manual/how-it-works/index.rst b/docs/graphql/manual/how-it-works/index.rst index d635254d90aed..cc3be6b29333b 100644 --- a/docs/graphql/manual/how-it-works/index.rst +++ b/docs/graphql/manual/how-it-works/index.rst @@ -68,7 +68,7 @@ Metadata All the information required for schema generation is stored by the Hasura GraphQL engine as metadata in its "catalogue" which is essentially a special Postgres schema in the database. -See :doc:`metadata catalogue ` for more details. +See :ref:`metadata catalogue ` for more details. .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst b/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst index 88173644deff8..f6086cd4701fa 100644 --- a/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst +++ b/docs/graphql/manual/migrations/advanced/writing-migrations-manually.rst @@ -28,7 +28,7 @@ Postgres schema and YAML for Hasura metadata actions. #. Edit the file and add your migration actions. For the file format and instructions on what actions can be added, refer to - :doc:`../reference/migration-file-format`. + :ref:`migration_file_format`. #. Apply the migration: diff --git a/docs/graphql/manual/migrations/existing-database.rst b/docs/graphql/manual/migrations/existing-database.rst index 176979472a727..578f761202142 100644 --- a/docs/graphql/manual/migrations/existing-database.rst +++ b/docs/graphql/manual/migrations/existing-database.rst @@ -139,7 +139,7 @@ instance at ``http://another-graphql-instance.herokuapp.com``: hasura migrate apply --endpoint http://another-graphql-instance.herokuapp.com In case you need an automated way of applying the migrations, take a look at the -:doc:`CLI-Migrations ` Docker image, which can start the +:ref:`CLI-Migrations ` Docker image, which can start the GraphQL engine after automatically applying the migrations which are mounted into a directory. diff --git a/docs/graphql/manual/migrations/index.rst b/docs/graphql/manual/migrations/index.rst index adf502415edc2..f0d68639db8d8 100644 --- a/docs/graphql/manual/migrations/index.rst +++ b/docs/graphql/manual/migrations/index.rst @@ -44,27 +44,27 @@ Simple use cases We will split the use cases into two: -1. :doc:`You're already using a migration tool for the Postgres schema - `. (like knex, TypeORM, Sequelize, Rails/Django +1. :ref:`You're already using a migration tool for the Postgres schema + `. (like knex, TypeORM, Sequelize, Rails/Django migrations. In this case you only need to manage the Hasura metadata) -2. :doc:`You're not using any migration tool for the Postgres schema - `. (Hasura will take care of the +2. :ref:`You're not using any migration tool for the Postgres schema + `. (Hasura will take care of the Postgres schema also) Advanced use cases ------------------ -- :doc:`auto-apply-migrations` -- :doc:`advanced/writing-migrations-manually` -- :doc:`advanced/rolling-back-migrations` +- :ref:`auto_apply_migrations` +- :ref:`manual_migrations` +- :ref:`roll_back_migrations` Reference documentation ----------------------- -- :doc:`reference/how-it-works` -- :doc:`reference/migration-file-format` -- :doc:`reference/metadata-file-format` +- :ref:`migrations_how_to` +- :ref:`migration_file_format` +- :ref:`metadata_file_format` .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/migrations/manage-metadata.rst b/docs/graphql/manual/migrations/manage-metadata.rst index 23c1a62502da5..2a4728ebbfd0a 100644 --- a/docs/graphql/manual/migrations/manage-metadata.rst +++ b/docs/graphql/manual/migrations/manage-metadata.rst @@ -38,8 +38,8 @@ Exporting Hasura metadata .. tab:: API - The export can be done via the :doc:`Metadata API - <../api-reference/schema-metadata-api/manage-metadata>`. + The export can be done via the :ref:`Metadata API + `. Response will be a JSON object with the Hasura metadata. Here is an example using ``curl`` to save this as a file: @@ -72,8 +72,8 @@ before. .. tab:: API - The exported JSON can be imported via the :doc:`Metadata API - <../api-reference/schema-metadata-api/manage-metadata>`. + The exported JSON can be imported via the :ref:`Metadata API + `. Here is an example using ``curl``: .. code-block:: bash @@ -112,8 +112,8 @@ when a new column has been added to a table via an external tool such as ``psql` .. tab:: API - The reload of metadata can be done via the :doc:`Metadata API - <../api-reference/schema-metadata-api/manage-metadata>`. + The reload of metadata can be done via the :ref:`Metadata API + `. Here is an example using ``curl``: .. code-block:: bash @@ -136,5 +136,5 @@ Using tools like ``curl`` you can easily integrate the metadata API requests for actions with your CI/CD workflows. In case you need an automated way of applying/importing the metadata, take a -look at the :doc:`CLI-Migrations ` Docker image, which +look at the :ref:`CLI-Migrations ` Docker image, which can start the GraphQL engine after automatically importing a mounted metadata file. diff --git a/docs/graphql/manual/migrations/manage-migrations.rst b/docs/graphql/manual/migrations/manage-migrations.rst index 47d9d95f38676..d1d689b92c64c 100644 --- a/docs/graphql/manual/migrations/manage-migrations.rst +++ b/docs/graphql/manual/migrations/manage-migrations.rst @@ -21,8 +21,8 @@ controlled and can be used with your CI/CD system to make incremental updates. When you're looking to set up migrations, there are two scenarios: -#. :doc:`You already have a database and Hasura setup `. -#. :doc:`You're starting from scratch - an empty database and a fresh Hasura instance `. +#. :ref:`You already have a database and Hasura setup `. +#. :ref:`You're starting from scratch - an empty database and a fresh Hasura instance `. .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/migrations/new-database.rst b/docs/graphql/manual/migrations/new-database.rst index 939055491a051..314d07c9cda55 100644 --- a/docs/graphql/manual/migrations/new-database.rst +++ b/docs/graphql/manual/migrations/new-database.rst @@ -99,7 +99,7 @@ instance at ``http://another-graphql-instance.herokuapp.com``: hasura migrate apply --endpoint http://another-graphql-instance.herokuapp.com In case you need an automated way of applying the migrations, take a look at the -:doc:`CLI-Migrations ` Docker image, which can start the +:ref:`CLI-Migrations ` Docker image, which can start the GraphQL engine after automatically applying the migrations which are mounted into a directory. diff --git a/docs/graphql/manual/migrations/reference/how-it-works.rst b/docs/graphql/manual/migrations/reference/how-it-works.rst index c863b4045f2cf..1709685eddb55 100644 --- a/docs/graphql/manual/migrations/reference/how-it-works.rst +++ b/docs/graphql/manual/migrations/reference/how-it-works.rst @@ -13,13 +13,13 @@ How Hasura migrations work :local: This is an explanation on how the Hasura migration system works. To understand how -to use the system, refer to :doc:`Migrations & Metadata <../index>`. +to use the system, refer to :ref:`Migrations & Metadata `. Metadata -------- Let's first talk about metadata. Whenever you do certain actions on the console -or via the API, Hasura records it in the :doc:`metadata catalogue <../../how-it-works/metadata-schema>` +or via the API, Hasura records it in the :ref:`metadata catalogue ` which is a schema called ``hdb_catalog`` in your Postgres database. For example, if you track a table, a new entry is created in the ``hdb_catalog.hdb_table`` table in Postgres. Similarly, there are more tables in this schema to track relationships, event triggers, diff --git a/docs/graphql/manual/migrations/reference/metadata-file-format.rst b/docs/graphql/manual/migrations/reference/metadata-file-format.rst index 4311cf3133ee9..9e42fed810537 100644 --- a/docs/graphql/manual/migrations/reference/metadata-file-format.rst +++ b/docs/graphql/manual/migrations/reference/metadata-file-format.rst @@ -141,7 +141,7 @@ defined for each table. Here is an example metadata file: update_permissions: [] The schema for this file will mostly correspond to the table structure of the -:doc:`metadata catalogue <../../how-it-works/metadata-schema>` +:ref:`metadata catalogue `. config v2 --------- @@ -160,9 +160,9 @@ For ``config v2``, the ``config.yaml`` of your Hasura project would look like: With ``config v2``, the metadata that is exported from the server is a directory of multiple files. When you run ``hasura metadata export``, the following files will be generated in the ``metadata/`` directory of your project. - ``version.yaml``: Contains the metadata version of the server -- ``tables.yaml``: Contains the metadata related to tables. -- ``remote_schemas.yaml``: Contains the metadata related to :doc:`remote schemas<../../remote-schemas/index>` -- ``functions.yaml``: Contains the metadata related to :doc:`custom functions<../../schema/custom-functions>` -- ``allow_list.yaml``: Contains the metadata related to :doc:`allow lists<../../deployment/allow-list>` -- ``actions.yaml``: Contains the metadata related to :doc:`actions<../../actions/index>` +- ``tables.yaml``: Contains the metadata related to tables +- ``remote_schemas.yaml``: Contains the metadata related to :ref:`remote schemas` +- ``functions.yaml``: Contains the metadata related to :ref:`custom functions` +- ``allow_list.yaml``: Contains the metadata related to :ref:`allow lists` +- ``actions.yaml``: Contains the metadata related to :ref:`actions` - ``actions.graphql``: Contains all the action definition and custom type definitions diff --git a/docs/graphql/manual/mutations/delete.rst b/docs/graphql/manual/mutations/delete.rst index cad3882d9b84b..da7f83a6ca26b 100644 --- a/docs/graphql/manual/mutations/delete.rst +++ b/docs/graphql/manual/mutations/delete.rst @@ -33,7 +33,7 @@ Auto-generated delete mutation schema As you can see from the schema: -- The ``where`` argument is compulsory to filter rows to be deleted. See :doc:`Filter queries <../queries/query-filters>` +- The ``where`` argument is compulsory to filter rows to be deleted. See :ref:`Filter queries ` for filtering options. Objects can be deleted based on filters on their own fields or those in their nested objects. The ``{}`` expression can be used to delete 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/manual/mutations/insert.rst b/docs/graphql/manual/mutations/insert.rst index ae5576bfa4d38..ac661792a20d0 100644 --- a/docs/graphql/manual/mutations/insert.rst +++ b/docs/graphql/manual/mutations/insert.rst @@ -41,7 +41,7 @@ Auto-generated insert mutation schema As you can see from the schema: - ``objects`` argument is necessary and you can pass multiple ``objects`` to the mutation. -- You can pass an ``on_conflict`` argument to convert the mutation to an :doc:`upsert mutation `. +- You can pass an ``on_conflict`` argument to convert the mutation to an :ref:`upsert mutation `. - You can return the number of affected rows and the affected objects (with nested objects) in the response. - You can use the single object insert to get the inserted object directly as the mutation response. @@ -635,7 +635,7 @@ Set a field to its default value during insert ---------------------------------------------- To set a field to its ``default`` value, just omit it from the input object, irrespective of the -:doc:`default value configuration <../schema/default-values/index>` i.e. via Postgres defaults or using column presets. +:ref:`default value configuration ` i.e. via Postgres defaults or using column presets. **Example:** If the default value of ``id`` is set to auto-incrementing integer, there's no need to pass the ``id`` field to the input object: diff --git a/docs/graphql/manual/mutations/update.rst b/docs/graphql/manual/mutations/update.rst index 0b0c85f69e471..05c9d88c4f05e 100644 --- a/docs/graphql/manual/mutations/update.rst +++ b/docs/graphql/manual/mutations/update.rst @@ -35,7 +35,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 :doc:`Filter queries <../queries/query-filters>` +- 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/manual/mutations/upsert.rst b/docs/graphql/manual/mutations/upsert.rst index 4a66d2ddd8a52..51208e775c1c3 100644 --- a/docs/graphql/manual/mutations/upsert.rst +++ b/docs/graphql/manual/mutations/upsert.rst @@ -24,7 +24,7 @@ Convert insert mutation to upsert Only tables with **update** permissions are **upsertable**. i.e. a table's update permissions are respected before updating an existing row in case of a conflict. -To convert an :doc:`insert mutation ` into an upsert, you need to use the ``on_conflict`` argument to specify: +To convert an :ref:`insert mutation ` into an upsert, you need to use the ``on_conflict`` argument to specify: - a **unique or primary key constraint** using the ``constraint`` field, and - the **columns to be updated** in the case of a violation of that constraint using the ``update_columns`` field. diff --git a/docs/graphql/manual/queries/distinct-queries.rst b/docs/graphql/manual/queries/distinct-queries.rst index 1018599c7e5bb..c654f5756ace6 100644 --- a/docs/graphql/manual/queries/distinct-queries.rst +++ b/docs/graphql/manual/queries/distinct-queries.rst @@ -20,7 +20,7 @@ You can fetch rows with only distinct values of a column using the ``distinct_on It is typically recommended to use ``order_by`` along with ``distinct_on`` to ensure we get predictable results *(otherwise any arbitrary row with a distinct value of the column may be returned)*. Note that the ``distinct_on`` column needs to be the first column in the ``order_by`` expression. -See :doc:`sort queries ` for more info on using ``order_by``. +See :ref:`sort queries ` for more info on using ``order_by``. .. code-block:: graphql diff --git a/docs/graphql/manual/queries/index.rst b/docs/graphql/manual/queries/index.rst index c2722ca4b2bcc..74cc6b807a8f4 100644 --- a/docs/graphql/manual/queries/index.rst +++ b/docs/graphql/manual/queries/index.rst @@ -40,7 +40,7 @@ Auto-generated query field schema order_by: [author_order_by!] ): [author] -See the :doc:`Query API reference <../api-reference/graphql-api/query>` for the full specifications +See the :ref:`Query API reference ` for the full specifications .. note:: diff --git a/docs/graphql/manual/queries/nested-object-queries.rst b/docs/graphql/manual/queries/nested-object-queries.rst index 208227471abd2..b049840893d4a 100644 --- a/docs/graphql/manual/queries/nested-object-queries.rst +++ b/docs/graphql/manual/queries/nested-object-queries.rst @@ -12,7 +12,7 @@ Nested object queries :depth: 2 :local: -You can use the object (one-to-one) or array (one-to-many) :doc:`relationships <../schema/relationships/index>` defined +You can use the object (one-to-one) or array (one-to-many) :ref:`relationships ` defined in your schema to make a nested query i.e. fetch data for a type along with data from a nested or related type. The **name of the nested object** is the same as the name of the object/array relationship configured in diff --git a/docs/graphql/manual/queries/pagination.rst b/docs/graphql/manual/queries/pagination.rst index c7ac5f702281f..17817f207539f 100644 --- a/docs/graphql/manual/queries/pagination.rst +++ b/docs/graphql/manual/queries/pagination.rst @@ -323,6 +323,6 @@ articles to return. .. admonition:: Caveat - If this needs to be done over :doc:`subscriptions <../subscriptions/index>`, two subscriptions will need to be run + If this needs to be done over :ref:`subscriptions `, two subscriptions will need to be run as Hasura follows the `GraphQL spec `_ which allows for only one root field in a subscription. diff --git a/docs/graphql/manual/remote-schemas/index.rst b/docs/graphql/manual/remote-schemas/index.rst index 1b5cfe30c3c04..e458d77db37ee 100644 --- a/docs/graphql/manual/remote-schemas/index.rst +++ b/docs/graphql/manual/remote-schemas/index.rst @@ -49,7 +49,7 @@ a union of top-level nodes from each of the sub-schemas. If you are looking for adding authorization & access control for your app users to the GraphQL APIs that are auto-generated via Hasura, head to - :doc:`../auth/index` + :ref:`auth` Adding a remote schema ---------------------- @@ -137,7 +137,7 @@ metadata modifying operation like adding tables/functions, defining relationship From ``v1.0.0-beta.3`` onwards, a remote server's GraphQL schema is cached and refreshed only when user explicitly reloads remote schema by clicking the ``Reload`` button on the console or -by making a :doc:`reload_remote_schema<../api-reference/schema-metadata-api/remote-schemas>` metadata API request +by making a :ref:`reload_remote_schema` metadata API request Current limitations @@ -214,7 +214,7 @@ Hasura. However a similar solution can be achieved by the following workarounds: Bypassing webhook authorization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you have a :doc:`webhook authorization setup <../auth/authentication/webhook>`, in the normal scenario, your authorization +If you have a :ref:`webhook authorization setup `, in the normal scenario, your authorization webhook would return ``200`` on success and ``401`` if it is either unable to authorize the current request or if the authorization information is absent (like cookie, authorization header etc.) @@ -228,7 +228,7 @@ To bypass the webhook auth: Bypassing JWT authorization ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you have a :doc:`JWT authorization setup <../auth/authentication/jwt>`, to bypass the JWT auth: +If you have a :ref:`JWT authorization setup `, to bypass the JWT auth: - your authentication server should generate a static JWT token for ``anonymous`` i.e. unauthenticated users. - when adding the remote schema, check the ``Forward all headers from client`` option so that the remote server diff --git a/docs/graphql/manual/schema/basics.rst b/docs/graphql/manual/schema/basics.rst index 79297e4800728..ed83e8b9df5e1 100644 --- a/docs/graphql/manual/schema/basics.rst +++ b/docs/graphql/manual/schema/basics.rst @@ -90,7 +90,7 @@ The following object type and query/mutation fields are generated for the ``arti where: article_bool_exp! ): article_mutation_response -See the :doc:`query <../api-reference/graphql-api/query>` and :doc:`mutation <../api-reference/graphql-api/mutation>` +See the :ref:`query ` and :ref:`mutation ` API references for the full specifications. You can insert some sample data into the tables using the ``Insert Row`` tab of the created tables. diff --git a/docs/graphql/manual/schema/computed-fields.rst b/docs/graphql/manual/schema/computed-fields.rst index 38327081e0b96..37e9ee7e96a23 100644 --- a/docs/graphql/manual/schema/computed-fields.rst +++ b/docs/graphql/manual/schema/computed-fields.rst @@ -102,7 +102,7 @@ The return table must be tracked to define such a computed field. **Example:** -In a simple ``author <-> article`` schema, we can define a :doc:`relationship <../schema/relationships/index>` on the ``author`` +In a simple ``author <-> article`` schema, we can define a :ref:`relationship ` on the ``author`` table to fetch authors along with their articles. We can make use of computed fields to fetch the author's articles with a search parameter. @@ -181,13 +181,13 @@ Adding a computed field to a table .. tab:: API - A computed field can be added to a table using the :doc:`add_computed_field <../api-reference/schema-metadata-api/computed-field>` + A computed field can be added to a table using the :ref:`add_computed_field ` metadata API Computed fields permissions --------------------------- -:doc:`Access control <../auth/authorization/index>` to computed fields depends on the type of computed field. +:ref:`Access control ` to computed fields depends on the type of computed field. - For **scalar computed fields**, permissions are managed similar to the :ref:`columns permissions ` of the table. diff --git a/docs/graphql/manual/schema/custom-functions.rst b/docs/graphql/manual/schema/custom-functions.rst index eb841f12d8a26..9c4828a33a575 100644 --- a/docs/graphql/manual/schema/custom-functions.rst +++ b/docs/graphql/manual/schema/custom-functions.rst @@ -456,7 +456,7 @@ Use the ``->>`` JSON operator to fetch the value of a session variable as shown Permissions for custom function queries --------------------------------------- -:doc:`Access control permissions <../auth/authorization/permission-rules>` configured for the ``SETOF`` table of a function are also applicable to the function itself. +:ref:`Access control permissions ` configured for the ``SETOF`` table of a function are also applicable to the function itself. **For example**, in our text-search example above, if the role ``user`` doesn't have the requisite permissions to view the table ``article``, a validation error will be thrown if the ``search_articles`` query is run using the ``user`` diff --git a/docs/graphql/manual/schema/default-values/column-presets.rst b/docs/graphql/manual/schema/default-values/column-presets.rst index 59d6f02994062..c63e16c788964 100644 --- a/docs/graphql/manual/schema/default-values/column-presets.rst +++ b/docs/graphql/manual/schema/default-values/column-presets.rst @@ -13,7 +13,7 @@ Setting default values for fields using role-based column presets :local: Let's say you want certain fields to have their values set automatically when not explicitly passed using session -variables or fixed values when a new row is created with a particular :doc:`user role <../../auth/authorization/roles-variables>`. +variables or fixed values when a new row is created with a particular :ref:`user role `. Hasura GraphQL engine's column presets let you define role-based default values for any field/column. These values can either be a session variable value or a static value. @@ -91,5 +91,5 @@ passed in the ``X-Hasura-User-Id`` variable: Also see -------- -- :doc:`postgres-defaults` -- :doc:`sql-functions` +- :ref:`postgres_defaults` +- :ref:`sql_functions` diff --git a/docs/graphql/manual/schema/default-values/index.rst b/docs/graphql/manual/schema/default-values/index.rst index 2568855f150bc..727584611acfb 100644 --- a/docs/graphql/manual/schema/default-values/index.rst +++ b/docs/graphql/manual/schema/default-values/index.rst @@ -15,14 +15,14 @@ Setting default values for fields Let's say you want certain fields to have their values set automatically when not explicitly passed. You can do this in the following ways: -- :doc:`Postgres defaults `: configure default values, using fixed values or simple SQL functions, +- :ref:`Postgres defaults `: configure default values, using fixed values or simple SQL functions, for columns in the table definition. E.g. an auto-incrementing ``id``, a ``created_at`` timestamp, etc. -- :doc:`Custom SQL functions `: set up Postgres triggers which run custom SQL functions/stored procedures +- :ref:`Custom SQL functions `: set up Postgres triggers which run custom SQL functions/stored procedures to set the values of certain columns on inserts/updates on the table. This is useful to set values of fields which depend on other fields passed in the input. e.g. set ``submission_time`` of an online quiz as 1 hour from the ``start_time``. -- :doc:`Role based column presets `: set up presets, using session variables or fixed values, that are - applied when a new row is created with a particular :doc:`user role <../../auth/authorization/roles-variables>`. +- :ref:`Role based column presets `: set up presets, using session variables or fixed values, that are + applied when a new row is created with a particular :ref:`user role `. E.g. set a ``user_id`` field automatically from a session variable/authorization header. .. toctree:: diff --git a/docs/graphql/manual/schema/default-values/postgres-defaults.rst b/docs/graphql/manual/schema/default-values/postgres-defaults.rst index 5af13b7ca294a..baaa9c1ef0038 100644 --- a/docs/graphql/manual/schema/default-values/postgres-defaults.rst +++ b/docs/graphql/manual/schema/default-values/postgres-defaults.rst @@ -62,5 +62,5 @@ value will be set automatically by Postgres. Also see -------- -- :doc:`sql-functions` -- :doc:`column-presets` +- :ref:`sql_functions` +- :ref:`column_presets` diff --git a/docs/graphql/manual/schema/default-values/sql-functions.rst b/docs/graphql/manual/schema/default-values/sql-functions.rst index 9338b72addcd4..fdb58e146f88b 100644 --- a/docs/graphql/manual/schema/default-values/sql-functions.rst +++ b/docs/graphql/manual/schema/default-values/sql-functions.rst @@ -103,5 +103,5 @@ value (output="YABBA DABBA DOO!") will be set automatically. Also see -------- -- :doc:`postgres-defaults` -- :doc:`column-presets` +- :ref:`postgres_defaults` +- :ref:`column_presets` diff --git a/docs/graphql/manual/schema/enums.rst b/docs/graphql/manual/schema/enums.rst index a1f48fdc3f98b..62353d16afece 100644 --- a/docs/graphql/manual/schema/enums.rst +++ b/docs/graphql/manual/schema/enums.rst @@ -239,7 +239,7 @@ This can be achieved via the console by performing the following steps while set 2. Use the ``RawSQL`` tab of the console to insert the enum values into the table and mark the insert as a migration 3. Set the table as an enum -You can also :doc:`manually create migration files <../migrations/advanced/writing-migrations-manually>` to achieve +You can also :ref:`manually create migration files ` to achieve this. Current limitations diff --git a/docs/graphql/manual/schema/index.rst b/docs/graphql/manual/schema/index.rst index d465829c28560..b1724a20c8fda 100644 --- a/docs/graphql/manual/schema/index.rst +++ b/docs/graphql/manual/schema/index.rst @@ -14,7 +14,7 @@ Schema The Hasura GraphQL engine automatically generates your GraphQL schema and resolvers based on your tables/views in Postgres. **You don't need to write a GraphQL schema or resolvers.** See -:doc:`How Hasura GraphQL engine works <../how-it-works/index>` for more details. +:ref:`How Hasura GraphQL engine works ` for more details. The Hasura console gives you UI tools that speed up your data-modelling process, or working with your existing database. The console also automatically generates migrations or metadata files that you can edit directly and check into your diff --git a/docs/graphql/manual/schema/relationships/database-modelling/index.rst b/docs/graphql/manual/schema/relationships/database-modelling/index.rst index cc2ec84db5672..c3986072aa87a 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/index.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/index.rst @@ -14,9 +14,9 @@ Database modelling guides The following guides will help you model the different types of table relationships in the database: -- :doc:`one-to-one` -- :doc:`one-to-many` -- :doc:`many-to-many` +- :ref:`one_to_one_modelling` +- :ref:`one_to_many_modelling` +- :ref:`many_to_many_modelling` .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/schema/relationships/database-modelling/many-to-many.rst b/docs/graphql/manual/schema/relationships/database-modelling/many-to-many.rst index b60899fb26302..6d096527918f8 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/many-to-many.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/many-to-many.rst @@ -64,7 +64,7 @@ permutations of their association via the foreign keys. Set up GraphQL relationships ---------------------------- -To access the nested objects via the GraphQL API, :doc:`create the following relationships <../create>`: +To access the nested objects via the GraphQL API, :ref:`create the following relationships `: - Array relationship, ``article_tags`` from ``article`` table using ``article_tag :: article_id -> id`` - Object relationship, ``tag`` from ``article_tag`` table using ``tag_id -> tag :: id`` @@ -268,7 +268,7 @@ Flattening a many-to-many relationship query -------------------------------------------- In case you would like to flatten the above queries and avoid the intermediate fields ``article_tags`` & -``tag_articles``, you can :doc:`create the following views <../../views>` additionally and then +``tag_articles``, you can :ref:`create the following views ` additionally and then query using relationships created on these views: .. code-block:: sql @@ -283,7 +283,7 @@ query using relationships created on these views: FROM article_tag LEFT JOIN article ON article_tag.article_id = article.id -Now :doc:`create the following relationships <../create>`: +Now :ref:`create the following relationships `: - Array relationship, ``tags`` from the ``article`` table using ``article_tags_view :: article_id -> id`` - Array relationship, ``articles`` from the ``tag`` table using ``tag_articles_view :: tag_id -> id`` diff --git a/docs/graphql/manual/schema/relationships/database-modelling/one-to-many.rst b/docs/graphql/manual/schema/relationships/database-modelling/one-to-many.rst index 11559fd17ef85..c9ba8bb51637b 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/one-to-many.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/one-to-many.rst @@ -49,7 +49,7 @@ the ``author`` table. Set up GraphQL relationships ---------------------------- -To access the nested objects via the GraphQL API, :doc:`create the following relationships <../create>`: +To access the nested objects via the GraphQL API, :ref:`create the following relationships `: - Array relationship, ``articles`` from ``author`` table using ``article :: author_id -> id`` - Object relationship, ``author`` from ``article`` table using ``author_id -> author :: id`` diff --git a/docs/graphql/manual/schema/relationships/database-modelling/one-to-one.rst b/docs/graphql/manual/schema/relationships/database-modelling/one-to-one.rst index a9dd6528e855a..d0b84acadd786 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/one-to-one.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/one-to-one.rst @@ -51,7 +51,7 @@ the ``author`` table and there will be only one row with a particular ``owner_id Set up GraphQL relationships ---------------------------- -To access the nested objects via the GraphQL API, :doc:`create the following relationships <../create>`: +To access the nested objects via the GraphQL API, :ref:`create the following relationships `: - Object relationship, ``passport_info`` from the ``author`` table using ``id -> passport_info :: owner_id`` - Object relationship, ``owner`` from the ``passport_info`` table using ``owner_id -> author :: id`` diff --git a/docs/graphql/manual/schema/relationships/index.rst b/docs/graphql/manual/schema/relationships/index.rst index f9b2f39c57e65..b4e60d1d60b90 100644 --- a/docs/graphql/manual/schema/relationships/index.rst +++ b/docs/graphql/manual/schema/relationships/index.rst @@ -12,7 +12,7 @@ Relationships between tables/views :depth: 1 :local: -To make :doc:`nested object queries <../../queries/nested-object-queries>`, the tables/views in your database need to +To make :ref:`nested object queries `, the tables/views in your database need to be connected via relationships. Let's say we have the following tables in our database: ``author``, ``passport_info``, ``article`` and ``tag``. @@ -60,17 +60,17 @@ Managing GraphQL relationships See the following to manage the object/array relationships between tables/views for the GraphQL schema: -- :doc:`create` -- :doc:`rename` +- :ref:`create_relationships` +- :ref:`rename_relationships` Table relationships modelling guides ------------------------------------ The following guides will help you model the different types of table relationships in the database: -- :doc:`database-modelling/one-to-one` -- :doc:`database-modelling/one-to-many` -- :doc:`database-modelling/many-to-many` +- :ref:`one_to_one_modelling` +- :ref:`one_to_many_modelling` +- :ref:`many_to_many_modelling` .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/schema/using-existing-database.rst b/docs/graphql/manual/schema/using-existing-database.rst index 08d0c76fc40aa..34492a7e0d90e 100644 --- a/docs/graphql/manual/schema/using-existing-database.rst +++ b/docs/graphql/manual/schema/using-existing-database.rst @@ -38,7 +38,7 @@ To track all tables and views present in the database: Step 2: Track foreign-keys -------------------------- -Tracking a foreign-key means creating a :doc:`relationship ` between the tables involved in the +Tracking a foreign-key means creating a :ref:`relationship ` between the tables involved in the foreign-key. To track a foreign-key between two tables in the database: @@ -47,7 +47,7 @@ To track a foreign-key between two tables in the database: #. Head to the ``Data -> Schema`` section of the console. #. Click on a table involved in the foreign-key and head to the ``Relationships`` tab. #. You should see a suggested relationship based on the foreign-key. Click ``Add``, give a name to your relationship - (this will be the name of the :doc:`nested object <../queries/nested-object-queries>` in the GraphQL query), and + (this will be the name of the :ref:`nested object ` in the GraphQL query), and hit ``Save`` to create the relationship. #. Repeat with the other table involved in the foreign-key. @@ -62,7 +62,7 @@ To track all the foreign-keys of all tables in the database: .. admonition:: Relationship nomenclature In this case, Hasura GraphQL engine will **automatically generate relationship names** (the names of the - :doc:`nested objects <../queries/nested-object-queries>` in the GraphQL query) based on the table names and the + :ref:`nested objects ` in the GraphQL query) based on the table names and the foreign-key names. The name is generated in the following format: @@ -78,5 +78,5 @@ To track all the foreign-keys of all tables in the database: Note that, **this is just an arbitrary naming convention** chosen by Hasura to ensure the generation of unique relationship names. You can choose to rename your relationships to anything you wish. You can **change the - relationship names** with a name of your choice as shown in :doc:`relationships/rename`. + relationship names** with a name of your choice as shown in :ref:`rename_relationships`. diff --git a/docs/graphql/manual/subscriptions/index.rst b/docs/graphql/manual/subscriptions/index.rst index df303f76a7ee7..a68655fd341d0 100644 --- a/docs/graphql/manual/subscriptions/index.rst +++ b/docs/graphql/manual/subscriptions/index.rst @@ -19,7 +19,7 @@ A GraphQL subscription is essentially a query where the client receives an updat changes upstream. Subscriptions are supported for all kinds of queries. All the concepts of -:doc:`queries <../queries/index>` hold true for subscriptions as well. +:ref:`queries ` hold true for subscriptions as well. Execution --------- @@ -30,7 +30,7 @@ latest result of the query being made and not necessarily all the individual eve By default updates are delivered to clients every **1 sec**. This interval can be configured via the ``HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL`` env var or the ``--live-queries-multiplexed-refetch-interval`` flag. See the -:doc:`server flag reference <../deployment/graphql-engine-flags/reference>` for info on setting the flag/env var. +:ref:`server flag reference ` for info on setting the flag/env var. You can read more about the implementation of subscriptions in the `architecture doc `_. @@ -107,7 +107,7 @@ It uses the provided CORS configuration (as per :ref:`configure-cors`). (because of potential security issues). To override the behaviour, you can use the flag ``--ws-read-cookie`` or the environment variable ``HASURA_GRAPHQL_WS_READ_COOKIE``. See - :doc:`../deployment/graphql-engine-flags/reference` for the setting. + :ref:`server_flag_reference` for the setting. .. toctree:: :maxdepth: 1 diff --git a/docs/graphql/manual/subscriptions/use-cases.rst b/docs/graphql/manual/subscriptions/use-cases.rst index 1fedb6ce003c8..efb74a4ee3ca5 100644 --- a/docs/graphql/manual/subscriptions/use-cases.rst +++ b/docs/graphql/manual/subscriptions/use-cases.rst @@ -224,7 +224,7 @@ First, create a view ``poll_results`` to give the result of the poll: This view will have the following fields: ``poll_id``, ``option_id`` and ``votes``, i.e. it gives the number of votes received by each option for a poll. -Next, :doc:`setup relationships <../schema/relationships/index>` ``poll`` and ``option`` between the ``poll_results`` view +Next, :ref:`setup relationships ` ``poll`` and ``option`` between the ``poll_results`` view and the ``poll`` and ``option`` tables using the ``poll_id`` and ``option_id`` fields respectively. Now we can use the following subscription to display the latest poll result: diff --git a/docs/graphql/manual/troubleshooting/index.rst b/docs/graphql/manual/troubleshooting/index.rst index 86dce1c0b2859..ff9d257c2f8c2 100644 --- a/docs/graphql/manual/troubleshooting/index.rst +++ b/docs/graphql/manual/troubleshooting/index.rst @@ -17,7 +17,7 @@ the GraphQL engine are altered using ``psql`` or any other PostgreSQL client. The Hasura GraphQL engine creates and maintains an **internal state** based on the database it is configured to use. This internal state will comprise information about the tables/views, relationships and access control rules -defined on them using the Hasura GraphQL engine. See :doc:`Hasura GraphQL metadata schema <../how-it-works/metadata-schema>` +defined on them using the Hasura GraphQL engine. See :ref:`Hasura GraphQL metadata schema ` for information on how this internal state is maintained. It is highly recommended doing any modifications to the database schema only through the Hasura console to avoid corrupting the GraphQL engine's state. From 6fb6f3816e9997e7243badfb4cc340d16d33bfa3 Mon Sep 17 00:00:00 2001 From: rikinsk Date: Wed, 11 Mar 2020 19:11:09 +0530 Subject: [PATCH 3/4] add note to contrib guide --- docs/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3e355a043c1b4..d1a4513006627 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -104,6 +104,8 @@ without losing any visible quality. - Use bold in headings in place of string literals for aesthetics (i.e. ** in place of ``) - While adding code blocks ensure the right language type is set. Sometimes adding placeholders breaks the language's syntax in which case you'll have to set the language type to `none` to avoid warnings during builds. +- Use `:ref:` instead of `:doc:` to link to pages to avoid having to set the relative path and chances of broken links +while moving pages ### Pre-commit checks - Just before committing your changes, delete your local `_build` folder completely and then build docs again. Scan From ead25819ba2f4537bbc5b6475a89ddf46329ee60 Mon Sep 17 00:00:00 2001 From: rikinsk Date: Wed, 11 Mar 2020 23:50:12 +0530 Subject: [PATCH 4/4] update refs --- docs/graphql/manual/actions/action-connect.rst | 2 +- docs/graphql/manual/actions/codegen.rst | 2 +- docs/graphql/manual/actions/derive.rst | 2 +- .../api-reference/schema-metadata-api/syntax-defs.rst | 2 +- docs/graphql/manual/auth/authentication/jwt.rst | 2 +- docs/graphql/manual/deployment/production-checklist.rst | 8 ++++---- docs/graphql/manual/event-triggers/clean-up.rst | 2 +- .../manual/event-triggers/invoke-trigger-console.rst | 2 +- docs/graphql/manual/event-triggers/serverless.rst | 2 +- .../manual/guides/code-editor-integrations/index.rst | 2 +- .../code-editor-integrations/visual-studio-code.rst | 2 +- .../manual/guides/integrations/apollo-subscriptions.rst | 2 +- .../manual/guides/integrations/auth-guardian-jwt.rst | 2 +- docs/graphql/manual/guides/integrations/auth0-jwt.rst | 2 +- docs/graphql/manual/guides/integrations/aws-cognito.rst | 2 +- docs/graphql/manual/guides/integrations/index.rst | 8 ++++---- docs/graphql/manual/migrations/index.rst | 2 +- docs/graphql/manual/migrations/reference/how-it-works.rst | 2 +- docs/graphql/manual/queries/multiple-arguments.rst | 2 +- .../queries/variables-aliases-fragments-directives.rst | 2 +- .../manual/schema/default-values/column-presets.rst | 2 +- docs/graphql/manual/schema/default-values/index.rst | 4 ++-- .../manual/schema/default-values/postgres-defaults.rst | 2 +- .../manual/schema/default-values/sql-functions.rst | 2 +- .../schema/relationships/database-modelling/index.rst | 2 +- docs/graphql/manual/subscriptions/use-cases.rst | 2 +- 26 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/graphql/manual/actions/action-connect.rst b/docs/graphql/manual/actions/action-connect.rst index dbff4f247ec30..15f1f1d3b0658 100644 --- a/docs/graphql/manual/actions/action-connect.rst +++ b/docs/graphql/manual/actions/action-connect.rst @@ -2,7 +2,7 @@ :description: Connecting Hasura actions with the graph :keywords: hasura, docs, actions, connect -.. _connect: +.. _actions_connect: Connecting actions with the graph ================================= diff --git a/docs/graphql/manual/actions/codegen.rst b/docs/graphql/manual/actions/codegen.rst index efd0deedf2cd6..8280041876494 100644 --- a/docs/graphql/manual/actions/codegen.rst +++ b/docs/graphql/manual/actions/codegen.rst @@ -2,7 +2,7 @@ :description: Codegen for Hasura actions :keywords: hasura, docs, actions, codegen -.. _codegen: +.. _actions_codegen: Actions codegen =============== diff --git a/docs/graphql/manual/actions/derive.rst b/docs/graphql/manual/actions/derive.rst index b34ce48e49009..1a89115465ae7 100644 --- a/docs/graphql/manual/actions/derive.rst +++ b/docs/graphql/manual/actions/derive.rst @@ -2,7 +2,7 @@ :description: Deriving Hasura actions :keywords: hasura, docs, actions, derive -.. _derive: +.. _derive_actions: Deriving actions ================ diff --git a/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst b/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst index 278cc19d36d02..e98e496a57974 100644 --- a/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst +++ b/docs/graphql/manual/api-reference/schema-metadata-api/syntax-defs.rst @@ -2,7 +2,7 @@ :description: Common syntax definitions for the Hasura schema/metadata API :keywords: hasura, docs, schema/metadata API, API reference, syntax definitions -.. _api_syntax_defs: +.. _api_metadata_syntax_defs: Schema/Metadata API Reference: Common syntax definitions ======================================================== diff --git a/docs/graphql/manual/auth/authentication/jwt.rst b/docs/graphql/manual/auth/authentication/jwt.rst index ce682c5c5d7e5..95e362d966227 100644 --- a/docs/graphql/manual/auth/authentication/jwt.rst +++ b/docs/graphql/manual/auth/authentication/jwt.rst @@ -458,7 +458,7 @@ If you are using Firebase and Hasura, use this config: Auth0 ^^^^^ -Refer the :ref:`Auth0 JWT Integration guide ` for a full integration guide +Refer the :ref:`Auth0 JWT Integration guide ` for a full integration guide with Auth0. Auth0 publishes their JWK under: diff --git a/docs/graphql/manual/deployment/production-checklist.rst b/docs/graphql/manual/deployment/production-checklist.rst index e9349352d5483..13cbe20428437 100644 --- a/docs/graphql/manual/deployment/production-checklist.rst +++ b/docs/graphql/manual/deployment/production-checklist.rst @@ -29,7 +29,7 @@ recommended to keep this as a long string. # or use the flag graphql-engine --database-url= serve --admin-secret=averylongpasswordstring -More details can be found at :ref:`securing-graphql-endpoint`. +More details can be found at :ref:`securing_graphql_endpoint`. Verify permissions ------------------ @@ -78,7 +78,7 @@ By setting the above flag or env var, we are disabling the ``metadata``, ``pg_dump`` and ``config`` APIs. ``health`` and ``version`` APIs are public and cannot be disabled. -Read more about all the API types at the :ref:`API reference `. +Read more about all the API types at the :ref:`API reference `. .. note:: @@ -114,7 +114,7 @@ this particular instance. If your API is meant to serve a frontend client, you can only allow those requests used by the client to pass through. Every other request will be rejected without even getting validated. -Read more at :ref:`allow-list`. +Read more at :ref:`allow_list`. Restrict CORS domains --------------------- @@ -137,7 +137,7 @@ Enable HTTPS Production APIs should be served over HTTPS to be secure over the network. -See :ref:`enable-https` for details on achieving this. +See :ref:`enable_https` for details on achieving this. Configure logging ----------------- diff --git a/docs/graphql/manual/event-triggers/clean-up.rst b/docs/graphql/manual/event-triggers/clean-up.rst index 21142ada51216..85378a2e980ee 100644 --- a/docs/graphql/manual/event-triggers/clean-up.rst +++ b/docs/graphql/manual/event-triggers/clean-up.rst @@ -2,7 +2,7 @@ :description: Clean up event data of event triggers in Hasura :keywords: hasura, docs, event trigger, event data, clean up -.. _clean_up: +.. _clean_up_event_data: Clean up event data =================== diff --git a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst index 82e909270774b..281b04646ce6d 100644 --- a/docs/graphql/manual/event-triggers/invoke-trigger-console.rst +++ b/docs/graphql/manual/event-triggers/invoke-trigger-console.rst @@ -2,7 +2,7 @@ :description: Invoke event triggers on the Hasura console :keywords: hasura, docs, event trigger, console, invoke -.. _invoke_trigger: +.. _invoke_trigger_console: Invoke event trigger via console ================================ diff --git a/docs/graphql/manual/event-triggers/serverless.rst b/docs/graphql/manual/event-triggers/serverless.rst index dbbecaaf4e5eb..a7fba6a82f6f4 100644 --- a/docs/graphql/manual/event-triggers/serverless.rst +++ b/docs/graphql/manual/event-triggers/serverless.rst @@ -2,7 +2,7 @@ :description: Use serverless functions with Hasura event triggers :keywords: hasura, docs, event trigger, serverless function -.. _serverless: +.. _triggers_serverless: Using serverless functions ========================== diff --git a/docs/graphql/manual/guides/code-editor-integrations/index.rst b/docs/graphql/manual/guides/code-editor-integrations/index.rst index b871249a33d1a..9088b24804e62 100644 --- a/docs/graphql/manual/guides/code-editor-integrations/index.rst +++ b/docs/graphql/manual/guides/code-editor-integrations/index.rst @@ -12,7 +12,7 @@ Guides: Code Editor Integrations :depth: 1 :local: -- :ref:`Visual Studio Code ` +- :ref:`Visual Studio Code ` .. toctree:: diff --git a/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst b/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst index ffd39dacb22f9..89a045357bc38 100644 --- a/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst +++ b/docs/graphql/manual/guides/code-editor-integrations/visual-studio-code.rst @@ -2,7 +2,7 @@ :description: Visual studio code integration with Hasura :keywords: hasura, docs, guide, code editor, integration, visual studio code, vs code -.. _vs_code: +.. _guides_vs_code: Guides: Visual Studio Code Setup ================================ diff --git a/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst b/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst index f89cad7ea3cff..6f2e6616d0270 100644 --- a/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst +++ b/docs/graphql/manual/guides/integrations/apollo-subscriptions.rst @@ -2,7 +2,7 @@ :description: Set up GraphQL subscriptions with apollo-client :keywords: hasura, docs, guide, GraphQL subscriptions, apollo, apollo-client -.. _apollo_subscriptions: +.. _guides_apollo_subscriptions: Setting up GraphQL subscriptions using apollo-client ==================================================== diff --git a/docs/graphql/manual/guides/integrations/auth-guardian-jwt.rst b/docs/graphql/manual/guides/integrations/auth-guardian-jwt.rst index 93359e3a7b367..87f3a7dac4522 100644 --- a/docs/graphql/manual/guides/integrations/auth-guardian-jwt.rst +++ b/docs/graphql/manual/guides/integrations/auth-guardian-jwt.rst @@ -2,7 +2,7 @@ :description: Integrate AuthGuardian JWT with Hasura :keywords: hasura, docs, guide, authentication, auth, jwt, integration -.. _auth_guardian_jwt: +.. _guides_auth_guardian_jwt: OneGraph's AuthGuardian JWT Integration with Hasura GraphQL engine ================================================================== diff --git a/docs/graphql/manual/guides/integrations/auth0-jwt.rst b/docs/graphql/manual/guides/integrations/auth0-jwt.rst index 9c52b7587acb1..672438aee58bf 100644 --- a/docs/graphql/manual/guides/integrations/auth0-jwt.rst +++ b/docs/graphql/manual/guides/integrations/auth0-jwt.rst @@ -2,7 +2,7 @@ :description: Integrate Auth0 JWT with Hasura :keywords: hasura, docs, guide, authentication, auth, jwt, integration -.. _auth0_jwt: +.. _guides_auth0_jwt: Auth0 JWT Integration with Hasura GraphQL engine ================================================ diff --git a/docs/graphql/manual/guides/integrations/aws-cognito.rst b/docs/graphql/manual/guides/integrations/aws-cognito.rst index d1ed3a59acc88..8b89833b57d42 100644 --- a/docs/graphql/manual/guides/integrations/aws-cognito.rst +++ b/docs/graphql/manual/guides/integrations/aws-cognito.rst @@ -2,7 +2,7 @@ :description: Use AWS Cognito for authentication with Hasura :keywords: hasura, docs, guide, authentication, auth, integration -.. _aws_cognito: +.. _guides_aws_cognito: Using AWS Cognito for authentication ==================================== diff --git a/docs/graphql/manual/guides/integrations/index.rst b/docs/graphql/manual/guides/integrations/index.rst index 4b7f83a79abde..2325052a2fbc3 100644 --- a/docs/graphql/manual/guides/integrations/index.rst +++ b/docs/graphql/manual/guides/integrations/index.rst @@ -12,10 +12,10 @@ Guides: Integration/migration tutorials :depth: 1 :local: -- :ref:`auth0_jwt` -- :ref:`auth_guardian_jwt` -- :ref:`aws_cognito` -- :ref:`apollo_subscriptions` +- :ref:`guides_auth0_jwt` +- :ref:`guides_auth_guardian_jwt` +- :ref:`guides_aws_cognito` +- :ref:`guides_apollo_subscriptions` - `Blog: Move from firebase to realtime GraphQL on Postgres `__ - `Blog: Create a Gatsby site using GraphQL on Postgres `__ - `Blog: Instant GraphQL on AWS RDS `__ diff --git a/docs/graphql/manual/migrations/index.rst b/docs/graphql/manual/migrations/index.rst index f0d68639db8d8..7ca84ff21fed2 100644 --- a/docs/graphql/manual/migrations/index.rst +++ b/docs/graphql/manual/migrations/index.rst @@ -62,7 +62,7 @@ Advanced use cases Reference documentation ----------------------- -- :ref:`migrations_how_to` +- :ref:`migrations_how_it_works` - :ref:`migration_file_format` - :ref:`metadata_file_format` diff --git a/docs/graphql/manual/migrations/reference/how-it-works.rst b/docs/graphql/manual/migrations/reference/how-it-works.rst index 1709685eddb55..b28f2f3e3fd3c 100644 --- a/docs/graphql/manual/migrations/reference/how-it-works.rst +++ b/docs/graphql/manual/migrations/reference/how-it-works.rst @@ -2,7 +2,7 @@ :description: How Hasura migrations work :keywords: hasura, docs, migration, how it works -.. _migrations_how_to: +.. _migrations_how_it_works: How Hasura migrations work ========================== diff --git a/docs/graphql/manual/queries/multiple-arguments.rst b/docs/graphql/manual/queries/multiple-arguments.rst index ab4e4a103cf9f..814c7b6836ad3 100644 --- a/docs/graphql/manual/queries/multiple-arguments.rst +++ b/docs/graphql/manual/queries/multiple-arguments.rst @@ -2,7 +2,7 @@ :description: Use multiple arguments in a query in Hasura :keywords: hasura, docs, query, multiple arguments -.. _multiple_arguments: +.. _multiple_arguments_query: Using multiple arguments in a query =================================== diff --git a/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst b/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst index e817b7fb104ec..dc3cb57ac2f2e 100644 --- a/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst +++ b/docs/graphql/manual/queries/variables-aliases-fragments-directives.rst @@ -2,7 +2,7 @@ :description: Use variables, aliases, fragments and directives in Hasura queries :keywords: hasura, docs, query, variable, alias, fragment, directive -.. _variables_aliases: +.. _variables_aliases_fragments_directives: Using variables / aliases / fragments / directives in queries ============================================================= diff --git a/docs/graphql/manual/schema/default-values/column-presets.rst b/docs/graphql/manual/schema/default-values/column-presets.rst index c63e16c788964..12ab36bf4b11d 100644 --- a/docs/graphql/manual/schema/default-values/column-presets.rst +++ b/docs/graphql/manual/schema/default-values/column-presets.rst @@ -92,4 +92,4 @@ Also see -------- - :ref:`postgres_defaults` -- :ref:`sql_functions` +- :ref:`sql_functions_as_default` diff --git a/docs/graphql/manual/schema/default-values/index.rst b/docs/graphql/manual/schema/default-values/index.rst index 727584611acfb..59dff54697fb3 100644 --- a/docs/graphql/manual/schema/default-values/index.rst +++ b/docs/graphql/manual/schema/default-values/index.rst @@ -2,7 +2,7 @@ :description: Set default field values in Hasura :keywords: hasura, docs, schema, default value -.. _default_values: +.. _default_field_values: Setting default values for fields ================================= @@ -17,7 +17,7 @@ the following ways: - :ref:`Postgres defaults `: configure default values, using fixed values or simple SQL functions, for columns in the table definition. E.g. an auto-incrementing ``id``, a ``created_at`` timestamp, etc. -- :ref:`Custom SQL functions `: set up Postgres triggers which run custom SQL functions/stored procedures +- :ref:`Custom SQL functions `: set up Postgres triggers which run custom SQL functions/stored procedures to set the values of certain columns on inserts/updates on the table. This is useful to set values of fields which depend on other fields passed in the input. e.g. set ``submission_time`` of an online quiz as 1 hour from the ``start_time``. diff --git a/docs/graphql/manual/schema/default-values/postgres-defaults.rst b/docs/graphql/manual/schema/default-values/postgres-defaults.rst index baaa9c1ef0038..e01d7fb5c7363 100644 --- a/docs/graphql/manual/schema/default-values/postgres-defaults.rst +++ b/docs/graphql/manual/schema/default-values/postgres-defaults.rst @@ -62,5 +62,5 @@ value will be set automatically by Postgres. Also see -------- -- :ref:`sql_functions` +- :ref:`sql_functions_as_default` - :ref:`column_presets` diff --git a/docs/graphql/manual/schema/default-values/sql-functions.rst b/docs/graphql/manual/schema/default-values/sql-functions.rst index fdb58e146f88b..0ad95546d61c7 100644 --- a/docs/graphql/manual/schema/default-values/sql-functions.rst +++ b/docs/graphql/manual/schema/default-values/sql-functions.rst @@ -2,7 +2,7 @@ :description: Set default field values using SQL functions :keywords: hasura, docs, schema, default value, sql function, stored procedure -.. _sql_functions: +.. _sql_functions_as_default: Setting values of fields using SQL functions/stored procedures ============================================================== diff --git a/docs/graphql/manual/schema/relationships/database-modelling/index.rst b/docs/graphql/manual/schema/relationships/database-modelling/index.rst index c3986072aa87a..fc08506772a7f 100644 --- a/docs/graphql/manual/schema/relationships/database-modelling/index.rst +++ b/docs/graphql/manual/schema/relationships/database-modelling/index.rst @@ -2,7 +2,7 @@ :description: Relationships modelling in Hasura :keywords: hasura, docs, schema, database modelling -.. _database_modelling: +.. _relationship_database_modelling: Database modelling guides ========================= diff --git a/docs/graphql/manual/subscriptions/use-cases.rst b/docs/graphql/manual/subscriptions/use-cases.rst index efb74a4ee3ca5..0ac71aa74189c 100644 --- a/docs/graphql/manual/subscriptions/use-cases.rst +++ b/docs/graphql/manual/subscriptions/use-cases.rst @@ -2,7 +2,7 @@ :description: Use cases for Hasura subscriptions :keywords: hasura, docs, subscription, use case -.. _subscription_cases: +.. _subscription_use_cases: Subscriptions sample use cases ==============================