GA-ready docs (#2)

remove beta add some aura info
neo4j · Sep 2, 2024 · 9e90ca3 · 9e90ca3
1 parent e7b153e
commit 9e90ca3
Show file tree

Hide file tree

Showing 12 changed files with 13 additions and 28 deletions.
diff --git a/modules/ROOT/pages/authentication-authorization.adoc b/modules/ROOT/pages/authentication-authorization.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Authorize requests
 
 Unless authentication is disabled on the server, all requests must be authorized using the login credentials of a valid user.

diff --git a/modules/ROOT/pages/bookmarks.adoc b/modules/ROOT/pages/bookmarks.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Coordinate transactions and enforce causal consistency
 
 When working with a cluster, _bookmarks_ allow you to chain transactions and enforce <<causal_consistency>>.

diff --git a/modules/ROOT/pages/endpoints.adoc b/modules/ROOT/pages/endpoints.adoc
@@ -1,5 +1,5 @@
 :page-toclevels: -1
-:page-role: beta
+
 
 = Endpoints
 
@@ -11,7 +11,6 @@ This page contains a list of the endpoints that the Query API provides, plus poi
 
 |/
 |To obtain a list of available endpoints on your installation and some basic server information.
-label:not-on-aura[]
 
 |/db/<databaseName>/query/v2
 |To submit queries. +

diff --git a/modules/ROOT/pages/headers.adoc b/modules/ROOT/pages/headers.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Headers
 
 This page contains a full list of headers you may use to tweak the API behavior, or that the API may return in responses.

diff --git a/modules/ROOT/pages/impersonation.adoc b/modules/ROOT/pages/impersonation.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Run queries as a different user
 
 You can execute a query under the security context of a different user through the parameter `impersonatedUser` in the request body, specifying the name of the user to impersonate.

diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc
@@ -1,13 +1,12 @@
 :description: The Query API allows to execute Cypher statements against a Neo4j server through HTTP requests.
-:page-role: beta new-5.19
+:page-role: new-5.19
 
 
 = Introduction
 
 [NOTE]
-The Query API is disabled by default.
+The Query API is enabled by default on all <<Aura>> tiers, but disabled on self-managed instances.
 To enable it, add `QUERY_API_ENDPOINTS` to the configuration setting link:https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.http_enabled_modules[`server.http_enabled_modules`].
-The Query API is not available on Aura yet.
 
 The Query API allows to execute Cypher statements against a Neo4j server through HTTP requests.
 
@@ -16,14 +15,15 @@ If there exists an official library (driver) for the language you are using, con
 
 This guide assumes that you have:
 
-- A running Neo4j instance -- if not, check out how to link:{neo4j-docs-base-uri}/operations-manual/current/installation/[install Neo4j].
-- Some familiarity with <<Cypher>> -- if you need a hand, check out link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Getting started -> Cypher].
+- A running instance of Neo4j -- If you don't have one, link:https://neo4j.com/docs/operations-manual/current/installation/[install Neo4j locally] or sign up for an link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura cloud instance].
+- Some familiarity with <<Cypher>> -- If you are new to it, check out link:https://neo4j.com/docs/getting-started/cypher-intro/[Getting started -> Cypher].
 
-The Query API supports HTTP/2 as well as HTTP/1.1, unless either is explicitly disabled in the server configuration setting link:https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.http_enabled_transports[`server.http_enabled_transports`].
-It's up to the client to initiate a connection with the preferred protocol.
+**On self-managed instances**, the API uses port 7474 for HTTP and port 7473 for HTTPS by default. Ports can be altered via the configuration settings link:https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.http.listen_address[`server.http.listen_address`] and link:https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.https.listen_address[`server.https.listen_address`]. +
+**Aura instances** support only HTTPS through port 443.
 
 [TIP]
-By default, the Query API uses port 7474 for HTTP and port 7473 for HTTPS.
+The Query API supports HTTP/2 as well as HTTP/1.1, unless either is explicitly disabled in the server configuration setting link:https://neo4j.com/docs/operations-manual/current/configuration/configuration-settings/#config_server.http_enabled_transports[`server.http_enabled_transports`].
+It's up to the client to initiate a connection with the preferred protocol.
 
 
 ifndef::backend-pdf[]

diff --git a/modules/ROOT/pages/profile-query.adoc b/modules/ROOT/pages/profile-query.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Profile queries
 
 If a query is prepended with `EXPLAIN`, the server will return the _execution plan_ it would use to run it, but not actually execute it.

diff --git a/modules/ROOT/pages/query-counters.adoc b/modules/ROOT/pages/query-counters.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Retrieve query counters
 
 If `includeCounters: true` is added to the request body, the server returns query counters alongside the query result.

diff --git a/modules/ROOT/pages/query.adoc b/modules/ROOT/pages/query.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Query the database
 
 To run a query on a database, submit a `POST` request to the following endpoint:
@@ -15,7 +13,7 @@ http://<host>:<port>/db/<databaseName>/query/v2
 The server wraps the submitted Cypher query in a (implicit) <<transaction>> for you.
 This means that in case any part of the query fails, the database will be reverted back to its status before any part of the query was executed.
 
-It's not possible to control the lifecycle of transactions through the Query API.
+It's currently not possible to control the lifecycle of transactions through the Query API.
 If you need that flexibility, checkout the link:https://neo4j.com/docs/http-api/current[HTTP API] and  link:https://neo4j.com/docs/create-applications/[language libraries].
 
 [TIP]

diff --git a/modules/ROOT/pages/result-formats.adoc b/modules/ROOT/pages/result-formats.adoc
@@ -1,5 +1,5 @@
 :description: Query API result format.
-:page-role: beta
+
 
 = Result formats
 

diff --git a/modules/ROOT/pages/routing.adoc b/modules/ROOT/pages/routing.adoc
@@ -1,5 +1,3 @@
-:page-role: beta
-
 = Route queries to read cluster members
 
 In a cluster environment, all queries are routed to writer members by default.

diff --git a/modules/ROOT/partials/glossary.adoc b/modules/ROOT/partials/glossary.adoc
@@ -1,4 +1,6 @@
 [glossary]
+[[Aura]]Aura:: link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura] is Neo4j's fully managed cloud service.
+It comes with both free and paid plans.
 [[Cypher]]Cypher:: link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Cypher] is Neo4j's graph query language that lets you retrieve data from the database.
 It is like SQL, but for graphs.
 [[ACID]]ACID:: Atomicity, Consistency, Isolation, Durability (ACID) are properties guaranteeing that database transactions are processed reliably.