Update procedures descriptions and modes according to the test result… (#1186)

…s (#1155)

Update descriptions and modes of the procedures according to the [test
results](https://trello.com/c/bCR3TJOn)

---------

Co-authored-by: Reneta Popova <[email protected]>

Author: NataliaIvakina

modules/ROOT/pages/reference/procedures.adoc

@@ -243,7 +243,7 @@ In 4.2, signature changed to `db.listLocks() :: (mode :: STRING, resourceType ::
 | xref:reference/procedures.adoc#procedure_dbms_checkconfigvalue[`dbms.checkConfigValue()`]
 | label:no[]
 | label:yes[]
-| New in 5.0.
+| label:new[Introduced in 5.0]  label:admin-only[]
 
 // New in 4.0
 // Internal
@@ -765,9 +765,7 @@ m|READ
 |===
 | Description
 a|
-Wait for an index to come online.
-
-Example: `CALL db.awaitIndex("MyIndex", 300)`
+Wait for an index to come online (for example: `CALL db.awaitIndex("MyIndex", 300)`).
 | Signature
 m|db.awaitIndex(indexName :: STRING, timeOutSeconds = 300 :: INTEGER)
 | Mode
@@ -789,9 +787,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
 |===
 | Description
 a|
-Wait for all indexes to come online.
-
-Example: `CALL db.awaitIndexes(300)`
+Wait for all indexes to come online (for example: `CALL db.awaitIndexes(300)`).
 | Signature
 m|db.awaitIndexes(timeOutSeconds = 300 :: INTEGER)
 | Mode
@@ -853,13 +849,11 @@ m|DBMS
 |===
 | Description
 a|
-Update a given node property with the given vector in a more space efficient way than using link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`] directly.
-
-Returns the given node on which the property was set.
+Set a vector property on a given node in a more space efficient representation than Cypher’s link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`].
 | Signature
 m| db.create.setNodeVectorProperty(node :: NODE, key :: STRING, vector :: LIST<FLOAT>)
 | Mode
-m| WRITE
+m|WRITE
 |===
 
 [[procedure_db_create_setVectorProperty]]
@@ -868,13 +862,11 @@ m| WRITE
 |===
 | Description
 a|
-Update a given node property with the given vector in a more space efficient way than using link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`] directly.
-
-Returns the given node on which the property was set.
+Set a vector property on a given node in a more space efficient representation than Cypher’s link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/set#set-set-a-property[`SET`].
 | Signature
 m| db.create.setVectorProperty(node :: NODE, key :: STRING, vector :: LIST<FLOAT>) :: (node :: NODE)
 | Mode
-m| WRITE
+m|WRITE
 | Replaced by
 a|xref:reference/procedures.adoc#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty()`]
 |===
@@ -1037,7 +1029,7 @@ In the above equation, the trigonometric cosine is given by the scalar product o
 | Signature
 m| db.index.vector.createNodeIndex(indexName :: STRING, label :: STRING, propertyKey :: STRING, vectorDimension :: INTEGER, vectorSimilarityFunction :: STRING)
 | Mode
-m| SCHEMA
+m|SCHEMA
 |===
 
 [[procedure_db_index_vector_queryNodes]]
@@ -1047,14 +1039,12 @@ m| SCHEMA
 | Description
 a|
 Query the given vector index.
-
-Returns the requested number of approximate nearest neighbor nodes and their similarity score, ordered by the score.
-
-The similarity score is bounded between `0` and `1`; least to most similar respectively.
+Returns requested number of nearest neighbors to the provided query vector, and their similarity score to that query vector, based on the configured similarity function for the index.
+The similarity score is a value between [0, 1]; where `0` indicates least similar, `1` most similar.
 | Signature
 m| db.index.vector.queryNodes(indexName :: STRING, numberOfNearestNeighbours :: INTEGER, query :: LIST<FLOAT>) :: (node :: NODE, score :: FLOAT)
 | Mode
-m| READ
+m|READ
 |===
 
 [[procedure_db_info]]
@@ -1225,9 +1215,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
 |===
 | Description
 a|
-Schedule resampling of an index.
-
-Example: `CALL db.resampleIndex("MyIndex")`
+Schedule resampling of an index (for example: `CALL db.resampleIndex("MyIndex")`).
 | Signature
 m|db.resampleIndex(indexName :: STRING)
 | Mode
@@ -1316,9 +1304,11 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
 |===
 | Description
 a|
-Visualizes the schema of the data based on available statistics. A new node is returned for each label.
-The properties represented on the node include `name` (label name), `indexes` (list of indexes), and `constraints` (list of constraints).
+Visualizes the schema of the data based on available statistics.
+A new node is returned for each label.
+The properties represented on the node include: name (label name), indexes (list of indexes), and constraints (list of constraints).
 A relationship of a given type is returned for all possible combinations of start and end nodes.
+The properties represented on the relationship include: name (type name).
 Note that this may include additional relationships that do not exist in the data due to the information available in the count store.
 | Signature
 m|db.schema.visualization() :: (nodes :: LIST<NODE>, relationships :: LIST<RELATIONSHIP>)
@@ -1439,7 +1429,7 @@ m|READ
 |===
 
 [[procedure_dbms_checkconfigvalue]]
-.dbms.checkConfigValue() label:enterprise-edition[]
+.dbms.checkConfigValue() label:admin-only[] label:enterprise-edition[]
 [cols="<15s,<85"]
 |===
 | Description
@@ -1488,11 +1478,11 @@ m|WRITE
 |===
 | Description
 a|
-Checks the connectivity of this instance to other cluster members.
+Check the connectivity of this instance to other cluster members.
 Not all ports are relevant to all members.
 Valid values for 'port-name' are: [CLUSTER, RAFT].
 | Signature
-m|dbms.cluster.checkConnectivity
+m|dbms.cluster.checkConnectivity(port-name = null :: STRING, server = null :: STRING) :: (serverId :: STRING, mode-constraint :: STRING, port-name :: STRING, port-address :: STRING, result :: STRING)
 | Mode
 m|DBMS
 |===
@@ -1502,7 +1492,8 @@ m|DBMS
 [cols="<15s,<85"]
 |===
 | Description
-a| Marks a server in the topology as not suitable for new allocations.
+a|
+Mark a server in the topology as not suitable for new allocations.
 It will not force current allocations off the server.
 This is useful when deallocating databases when you have multiple unavailable servers.
 | Signature
@@ -1518,8 +1509,8 @@ m|WRITE
 |===
 | Description
 a|
-Returns endpoints of this instance.
-Used in disaster recovery.
+Returns the advertised bolt capable endpoints for a given database, divided by each endpoint’s capabilities.
+For example, an endpoint may serve read queries, write queries, and/or future `getRoutingTable` requests.
 | Signature
 m|dbms.cluster.routing.getRoutingTable(context :: MAP, database = null :: STRING) :: (ttl :: INTEGER, servers :: LIST<MAP>)
 | Mode
@@ -1535,12 +1526,10 @@ m|DBMS
 | Description
 a|
 Overview of installed protocols.
-
-Note that this can only be executed on a cluster core member.
 | Signature
 m|dbms.cluster.protocols() :: (orientation :: STRING, remoteAddress :: STRING, applicationProtocol :: STRING, applicationProtocolVersion :: INTEGER, modifierProtocols :: STRING)
 | Mode
-m|READ
+m|DBMS
 // | Default roles
 // m|reader, editor, publisher, architect, admin
 |===
@@ -1551,13 +1540,11 @@ m|READ
 |===
 | Description
 a|
-The toggle can pause or resume the pulling of new transactions for a specific database.
-If paused, the database secondary does not pull new transactions from the other cluster members for the specific database.
-The database secondary is still available for reads, you can perform a backup, etc.
+The toggle can pause or resume read replica (deprecated in favor of `dbms.cluster.secondaryReplicationDisable`)
 | Signature
 m|dbms.cluster.readReplicaToggle(databaseName :: STRING, pause :: BOOLEAN) :: (state :: STRING)
 | Mode
-m|READ
+m|DBMS
 | Replaced by
 a|xref:reference/procedures.adoc#procedure_dbms_cluster_secondaryreplicationdisable[`dbms.cluster.secondaryReplicationDisable()`]
 // | Default roles
@@ -1602,13 +1589,11 @@ CALL dbms.cluster.readReplicaToggle("neo4j", false)
 |===
 | Description
 a|
-The toggle can pause or resume the pulling of new transactions for a specific database.
-If paused, the database secondary does not pull new transactions from the other cluster members for the specific database.
-The database secondary is still available for reads, you can perform a backup, etc.
+The toggle can pause or resume the secondary replication process.
 | Signature
 m|dbms.cluster.secondaryReplicationDisable(databaseName :: STRING, pause :: BOOLEAN) :: (state :: STRING)
 | Mode
-m|READ
+m|DBMS
 // | Default roles
 // m|admin
 |===
@@ -1649,11 +1634,11 @@ CALL dbms.cluster.secondaryReplicationDisable("neo4j", false)
 [cols="<15s,<85"]
 |===
 | Description
-a| Removes the cordon on a server, returning it to 'enabled'.
+a| Remove the cordon on a server, returning it to 'enabled'.
 | Signature
 m| dbms.cluster.uncordonServer(server :: STRING)
 | Mode
-m| WRITE
+m|WRITE
 |===
 
 
@@ -1761,19 +1746,7 @@ m|DBMS
 |===
 | Description
 a|
-List all configuration settings whose names include the `searchString`, or all configuration settings if `searchString` is omitted.
-
-Use this procedure to check a setting's values, investigate when a value was set, or find information on valid values.
-
-Results include:
-
-* `value`: the current value of the setting.
-* `dynamic`: true if the value can be changed at runtime, or false if it requires a restart.
-* `defaultValue`: the default value of the setting.
-* `startupValue`: the value when the server was started, after _neo4j.conf_ and command line arguments have been applied.
-* `explicitlySet`: true if the value was set explicitly, or false if it was set by default.
-* `validValues`: contains information on data types and possible values for the settings.
-
+List the currently active configuration settings of Neo4j.
 | Signature
 m|dbms.listConfig(searchString =  :: STRING) :: (name :: STRING, description :: STRING, value :: STRING, dynamic :: BOOLEAN, defaultValue :: STRING, startupValue :: STRING, explicitlySet :: BOOLEAN, validValues :: STRING)
 | Mode
@@ -1825,8 +1798,7 @@ For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-ver
 |===
 | Description
 a|
-Place a database in quarantine or remove thereof.
-It must be executed over `bolt://`.
+Place a database into quarantine or remove it from it.
 | Signature
 m|dbms.quarantineDatabase(databaseName :: STRING, setStatus :: BOOLEAN, reason = No reason given :: STRING) :: (databaseName :: STRING, quarantined :: BOOLEAN, result :: STRING)
 | Mode
@@ -1841,10 +1813,7 @@ m|DBMS
 |===
 | Description
 a|
-Query JMX management data by domain and name.
-
-Valid queries should use the syntax outlined in the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/ObjectName.html[javax.management.ObjectName API documentation]. +
-For instance, use `+"*:*"+` to find all JMX beans.
+Query JMX management data by domain and name. For instance, use `:` to find all JMX beans.
 | Signature
 m|dbms.queryJmx(query :: STRING) :: (name :: STRING, description :: STRING, attributes :: MAP)
 | Mode
@@ -1860,7 +1829,8 @@ m|DBMS
 |===
 | Description
 a|
-Returns endpoints of this instance.
+Returns the advertised bolt capable endpoints for a given database, divided by each endpoint’s capabilities.
+For example an endpoint may serve read queries, write queries and/or future `getRoutingTable` requests.
 | Signature
 m|dbms.routing.getRoutingTable(context :: MAP, database = null :: STRING) :: (ttl :: INTEGER, servers :: LIST<MAP>)
 | Mode
@@ -1874,7 +1844,8 @@ m|DBMS
 [cols="<15s,<85"]
 |===
 | Description
-a| With this method you can set the allocator, which is responsible to select servers for hosting databases. The only current option is `EQUAL_NUMBERS`.
+a|
+With this method, you can set the allocator that is responsible for selecting servers for hosting databases.
 | Signature
 m|dbms.setDatabaseAllocator(allocator :: STRING)
 | Mode
@@ -1898,7 +1869,7 @@ a|WRITE
 [cols="<15s,<85"]
 |===
 | Description
-a| Changes the default database to the provided value.
+a| Change the default database to the provided value.
 The database must exist and the old default database must be stopped.
 | Signature
 m|dbms.setDefaultDatabase(databaseName :: STRING) :: (result :: STRING)