diff --git a/docs/_static/scripts/hdocs.js b/docs/_static/scripts/hdocs.js index e979aa3cbd4..aa3385889da 100644 --- a/docs/_static/scripts/hdocs.js +++ b/docs/_static/scripts/hdocs.js @@ -10,7 +10,7 @@ window.hdocs = (function () { document.getElementById('nav_tree_icon').addEventListener('click', hdocs.handleNavClick); document.getElementById('sidebar-close').addEventListener('click', hdocs.handleNavClick); - document.getElementById('close-banner').addEventListener('click', hdocs.closeBanner); + // document.getElementById('close-banner').addEventListener('click', hdocs.closeBanner); // document.getElementById('thumb_up_button').addEventListener('click', function () { hdocs.sendFeedback('positive', 'Great to hear that! If you have any other feedback, please share here:') }); // document.getElementById('thumb_down_button').addEventListener('click', function () { hdocs.sendFeedback('negative', 'Sorry to hear that. Please tell us what you were looking for:') }); diff --git a/docs/graphql/cloud/projects/create.rst b/docs/graphql/cloud/projects/create.rst index 87beb8b6648..d843e974ae3 100644 --- a/docs/graphql/cloud/projects/create.rst +++ b/docs/graphql/cloud/projects/create.rst @@ -15,7 +15,8 @@ Creating projects Introduction ------------ -You can create a new Hasura Cloud project with either a new Postgres database, or an existing Postgres database with a publicly available IP address. +You can create a new Hasura Cloud project with either a new Postgres database, or an existing +Postgres database with a publicly available IP address. Step 1: Project setup --------------------- @@ -50,9 +51,12 @@ On the Hasura console, navigate to ``Data -> Manage -> Connect Database``: New database ^^^^^^^^^^^^ -Hasura Cloud does not host databases, but does provide integrations with which you can create databases on managed cloud providers like Heroku. Integrations for AWS, GCP, and Azure are coming soon. +Hasura Cloud does not host databases, but does provide integrations with which you can create databases on +managed cloud providers like Heroku. Integrations for AWS, GCP, and Azure are coming soon. -To get started, choose ``Create Heroku Database -> Create Database``, and follow the prompts to authenticate with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier Postgres instance. You can always upgrade the instance and manage options later through your Heroku account. +To get started, choose ``Create Heroku Database -> Create Database``, and follow the prompts to authenticate +with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier +Postgres instance. You can always upgrade the instance and manage options later through your Heroku account. .. thumbnail:: /img/graphql/cloud/projects/project-new-database-setup.png :alt: database setup with new database @@ -60,7 +64,8 @@ To get started, choose ``Create Heroku Database -> Create Database``, and follow Existing database ^^^^^^^^^^^^^^^^^ -To use an existing database, choose ``Connect existing database`` and enter your database connection URL and enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``). +To use an existing database, choose ``Connect existing database`` and enter your database connection URL and +enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``). .. thumbnail:: /img/graphql/cloud/getting-started/connect-db.png :alt: database setup with existing database @@ -77,7 +82,9 @@ To use an existing database, choose ``Connect existing database`` and enter your Allowing connections from Hasura Cloud IP ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from the Hasura Cloud IP address. You can copy the IP address from the copy icon in the ``Hasura Cloud IP`` field on the project's details view. You may also need to disable SSL. Adding custom cert information to a Hasura Cloud instance is not yet available. +For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from +the Hasura Cloud IP address. You can copy the IP address from the copy icon in the ``Hasura Cloud IP`` field on the +project's details view. .. thumbnail:: /img/graphql/cloud/projects/hasura-cloud-ip.png :alt: Hasura Cloud IP field diff --git a/docs/graphql/core/api-reference/index.rst b/docs/graphql/core/api-reference/index.rst index cf91c966120..3274b856b53 100644 --- a/docs/graphql/core/api-reference/index.rst +++ b/docs/graphql/core/api-reference/index.rst @@ -28,7 +28,7 @@ Available APIs +----------------------------------+---------------------------------------------------+------------------+ | Metadata *(> v2.0)* | :ref:`/v1/metadata ` | Admin only | +----------------------------------+---------------------------------------------------+------------------+ -| Schema/Metadata *(< v1.3)* | :ref:`/v1/query ` | Admin only | +| Schema/Metadata *(deprecated)* | :ref:`/v1/query ` | Admin only | +----------------------------------+---------------------------------------------------+------------------+ | Restified GQL | :ref:`/api/rest ` | GQL REST Routes | +----------------------------------+---------------------------------------------------+------------------+ @@ -65,8 +65,8 @@ See details at :ref:`api_reference_relay_graphql`. .. _schema_api: -Schema API (v2.0 and above) -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Schema API +^^^^^^^^^^ Hasura exposes a schema API for directly executing SQL on the underlying Postgres. @@ -76,8 +76,8 @@ See details at :ref:`schema_apis`. .. _metadata_api: -Metadata API (v2.0 and above) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Metadata API +^^^^^^^^^^^^ Hasura exposes a metadata API for managing metadata. @@ -87,8 +87,8 @@ See details at :ref:`metadata_apis`. .. _schema_metadata_api: -Schema / metadata API (v1.3 and below) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Schema / metadata API (Deprecated) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Hasura exposes a schema / metadata API for managing metadata for permissions/relationships or for directly executing SQL on the underlying Postgres. @@ -163,9 +163,9 @@ See details at :ref:`explain_api_reference`. GraphQL API Relay GraphQL API - Schema APIs (v2.0 and above) - Metadata APIs (v2.0 and above) - Schema / Metadata APIs + Schema APIs + Metadata APIs + Schema / Metadata APIs (Deprecated) RESTified GraphQL Endpoints Version API Health check API diff --git a/docs/graphql/core/api-reference/metadata-api/index.rst b/docs/graphql/core/api-reference/metadata-api/index.rst index bd5e69850c3..e3ed8b0c3ce 100644 --- a/docs/graphql/core/api-reference/metadata-api/index.rst +++ b/docs/graphql/core/api-reference/metadata-api/index.rst @@ -4,8 +4,8 @@ .. _metadata_apis: -Metadata API Reference (v2.0 and above) -======================================= +Metadata API Reference +====================== .. contents:: Table of contents :backlinks: none diff --git a/docs/graphql/core/api-reference/schema-api/index.rst b/docs/graphql/core/api-reference/schema-api/index.rst index 11f97f808ef..61f7a6ff6e4 100644 --- a/docs/graphql/core/api-reference/schema-api/index.rst +++ b/docs/graphql/core/api-reference/schema-api/index.rst @@ -4,8 +4,8 @@ .. _schema_apis: -Schema API Reference (v2.0 and above) -===================================== +Schema API Reference +==================== .. contents:: Table of contents :backlinks: none diff --git a/docs/graphql/core/api-reference/schema-metadata-api/index.rst b/docs/graphql/core/api-reference/schema-metadata-api/index.rst index 3c30c394191..fe6de604d52 100644 --- a/docs/graphql/core/api-reference/schema-metadata-api/index.rst +++ b/docs/graphql/core/api-reference/schema-metadata-api/index.rst @@ -4,8 +4,8 @@ .. _schema_metadata_apis: -Schema / Metadata API Reference -=============================== +Schema / Metadata API Reference (Deprecated) +============================================ .. contents:: Table of contents :backlinks: none diff --git a/docs/graphql/core/databases/bigquery/getting-started.rst b/docs/graphql/core/databases/bigquery/getting-started.rst index a30470fb988..4bfa66106e3 100644 --- a/docs/graphql/core/databases/bigquery/getting-started.rst +++ b/docs/graphql/core/databases/bigquery/getting-started.rst @@ -86,7 +86,7 @@ Creating a Service Account :width: 400px -- Give it a name, and under roles, and grant these 3 roles: ``Bigquery Metadata Viewer``, ``BigQuery Data Viewer`` and ``BigQuery Job User``. +- Give it a name, and under roles, and grant these 3 roles: ``BigQuery Metadata Viewer``, ``BigQuery Data Viewer`` and ``BigQuery Job User``. .. thumbnail:: /img/graphql/core/databases/bigquery/2-service-account-details.png :alt: Add source diff --git a/docs/graphql/core/databases/citus-hyperscale-postgres/index.rst b/docs/graphql/core/databases/citus-hyperscale-postgres/index.rst index 43274f992cc..a6371823651 100644 --- a/docs/graphql/core/databases/citus-hyperscale-postgres/index.rst +++ b/docs/graphql/core/databases/citus-hyperscale-postgres/index.rst @@ -4,8 +4,8 @@ .. _database_citus-hyperscale-postgres: -Citus - Hyperscale (Postgres flavour) -===================================== +Citus / Hyperscale +================== .. contents:: Table of contents :backlinks: none diff --git a/docs/graphql/core/databases/postgres/schema/tables.rst b/docs/graphql/core/databases/postgres/schema/tables.rst index 3a112dc8ef8..81f74a470fa 100644 --- a/docs/graphql/core/databases/postgres/schema/tables.rst +++ b/docs/graphql/core/databases/postgres/schema/tables.rst @@ -208,6 +208,12 @@ in our table. See the :ref:`query ` and :ref:`mutation ` API references for the full specifications. +GraphQL types documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Hasura automatically picks up any comments that might have been added to your tables +and columns and adds them as GraphQL descriptions of the auto-generated types and fields. + Try out basic GraphQL requests ------------------------------