DOC-12386: Replace {tkn-db} (#854)

* Replace {tkn-db}
* Remove double escaping

Author: simon-dew

modules/ROOT/pages/_partials/_define_page_index.adoc

@@ -640,18 +640,18 @@ endif::xref--pfx-sgw[]
 :rest-api-admin--xref--sync-function: {rest-api-admin--pfx--database-configuration}/update_sync_function[\{db\}/_config/sync]
 :rest-api-admin--xref--replication: {rest-api-admin--pfx}#/Replication[Replication]
 
-:rest-api-admin-role-get--xref: {rest-api-admin--pfx}#/role/get__db___role__name_[/\{tkn-db}/_role/]
-:rest-api-admin-role-post--xref: {rest-api-admin--pfx}#/role/post__db___role[/\{tkn-db}/_role/]
-:rest-api-admin-role-put--xref: {rest-api-admin--pfx}#/role/put__db___role__name_[/\{tkn-db}/_role/\{name}]
+:rest-api-admin-role-get--xref: {rest-api-admin--pfx}#/role/get__db___role__name_[/\{db}/_role/]
+:rest-api-admin-role-post--xref: {rest-api-admin--pfx}#/role/post__db___role[/\{db}/_role/]
+:rest-api-admin-role-put--xref: {rest-api-admin--pfx}#/role/put__db___role__name_[/\{db}/_role/\{name}]
 
-:rest-api-admin-user-get--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{tkn-db}/_user/\{name}]
-:rest-api-admin-user-post--xref: {rest-api-admin--pfx}#/user/post\__db___user_[/\{tkn-db}/_user]
-:rest-api-admin-user-put--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{tkn-db}/_user/\{name}]
+:rest-api-admin-user-get--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{db}/_user/\{name}]
+:rest-api-admin-user-post--xref: {rest-api-admin--pfx}#/user/post\__db___user_[/\{db}/_user]
+:rest-api-admin-user-put--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{db}/_user/\{name}]
 
 :rest-api-admin--pfx--database-management: {rest-api-admin--pfx}#/Database_Management/
 :rest-api-admin--xref--database-management--compact: {rest-api-admin--pfx--database-management}post__db___compact[\{db\}/_compact]
 
-:rest-api-admin-doc-channels-get--xref: {rest-api-admin--pfx}#/database/get__db___all_docs[/\{tkn-db}/_alldocs]
+:rest-api-admin-doc-channels-get--xref: {rest-api-admin--pfx}#/database/get__db___all_docs[/\{db}/_alldocs]
 
 
 // :configuration-schema-access-control--page:  rest-api-admin-access-control.adoc
@@ -860,12 +860,12 @@ endif::xref--pfx-sgw[]
 :rest-api-admin--pfx-document: {xref-sgw--xref-admin-api-document}
 :xref-sgw--xref-admin-api-replication: {rest-api-admin--pfx}#/replication
 :xref-sgw--xref-admin-api-replication-post: {xref-sgw--xref-admin-api-replication}/post__db___replication__replicationID_
-:rest-api-admin--pfx-replication-delete: {xref-sgw--xref-admin-api-replication}/delete__db___replication__replicationID_[DELETE/\{tkn-url}/\{tkn-db}/_replication/example-rep-db1]
+:rest-api-admin--pfx-replication-delete: {xref-sgw--xref-admin-api-replication}/delete__db___replication__replicationID_[DELETE/\{url}/\{db}/_replication/example-rep-db1]
 :rest-api-admin--pfx-replication-post-remote: {xref-sgw--xref-admin-api-replication-post}[remote]
-:rest-api-admin--pfx-replication-post: {xref-sgw--xref-admin-api-replication-post}[POST/\{tkn-url}/\{tkn-db}/_replication/example-rep-db1]
-:rest-api-admin--pfx-replication-put: {xref-sgw--xref-admin-api-replication}/put__db___replication__replicationID_[PUT/\{tkn-url}/\{tkn-db}/_replication/example-rep-db1]
+:rest-api-admin--pfx-replication-post: {xref-sgw--xref-admin-api-replication-post}[POST/\{url}/\{db}/_replication/example-rep-db1]
+:rest-api-admin--pfx-replication-put: {xref-sgw--xref-admin-api-replication}/put__db___replication__replicationID_[PUT/\{url}/\{db}/_replication/example-rep-db1]
 :rest-api-admin--pfx-replication-repstatus-query: {xref-sgw--xref-admin-api-replication}/get__db___replicationStatus__queryString_[_replicationStatus]
-:rest-api-admin--pfx-replication-repstatus-set: {xref-sgw--xref-admin-api-replication}/put__db___replicationStatus__replicationID__action__action_[_replicationStatus(replicationID)?action={tkn-action}]
+:rest-api-admin--pfx-replication-repstatus-set: {xref-sgw--xref-admin-api-replication}/put__db___replicationStatus__replicationID__action__action_[_replicationStatus(replicationID)?action=\{action}]
 :rest-api-admin--pfx-replication-repstatus: {xref-sgw--xref-admin-api-replication}/get__db___replicationStatus__replicationID_[_replicationStatus(replicationID)]
 :rest-api-admin--pfx-replication: {xref-sgw--xref-admin-api-replication}
 

modules/ROOT/pages/_partials/incpg-icr-initialization.adoc

@@ -78,9 +78,9 @@ Running highlights::
 
 * REST ONLY
 
-** POST databases/\{tkn-db}/_replication creates a replication using the {rep-id} specified in the body or if none specified, a unique UUID.
+** POST databases/\{db}/_replication creates a replication using the replication ID specified in the body or if none specified, a unique UUID.
 
-** PUT databases/\{tkn-db}/_replication/\{rep-id} upserts replication {rep-id}.
+** PUT databases/\{db}/_replication/\{replicationID} upserts the replication with the specified ID.
 
 * {enterprise} only:
 

modules/ROOT/pages/_partials/sync-api/sync-function-api-expiry.adoc

@@ -69,7 +69,7 @@ This expiration time is not propagated when the document is replicated.
 The purge of the document does not cause it to be deleted on any other database.
 
 === Inspect a Document Expiry Value
-You can retrieve a document's expiration time, as it is returned in the response of GET xref:{rest-api--page}##/document/get__db___doc_[+/\{db/\{doc}] use `show_exp=true` as the querystring.
+You can retrieve a document's expiration time, as it is returned in the response of GET xref:{rest-api--page}#/document/get__db___doc_[+/{db}/{doc}+] using `show_exp=true` as the querystring.
 
 [source, bash]
 ----

modules/ROOT/pages/authentication-users.adoc

@@ -88,8 +88,8 @@ image::static-auth-provider.png[]
 
 API reference:
 
-- xref:rest-api.adoc#/auth/post\__db___facebook[/+\{db}+/_facebook]
-- xref:rest-api.adoc#/auth/post\__db___google[/+\{db}+/_google]
+- xref:rest-api.adoc#/auth/post\__db___facebook[/+{db}+/_facebook]
+- xref:rest-api.adoc#/auth/post\__db___google[/+{db}+/_google]
 
 For other providers we recommend to use Custom Authentication or OpenID Connect.
 
@@ -104,7 +104,7 @@ The last request creates a session.
 
 image::custom-auth-flow.png[]
 
-Given a user that has already been created, a new session for that user can be created on the Admin {rest-api-admin--pfx}#/session/post\__db___session[POST /+\{db}+/_session] endpoint.
+Given a user that has already been created, a new session for that user can be created on the Admin {rest-api-admin--pfx}#/session/post\__db___session[POST /+{db}+/_session] endpoint.
 
 [source,bash]
 ----
@@ -143,7 +143,7 @@ There are two implementation methods available with OpenID Connect:
 
 <<implicit-flow>>::
 With this method, the retrieval of the ID token takes place on the device.
-You can then create a user session using the POST `+/\{tkn-db}/_session+` endpoint on the Public REST API with the ID token.
+You can then create a user session using the POST `+/{db}/_session+` endpoint on the Public REST API with the ID token.
 <<authorization-code-flow>>::
 This method relies on {sgw} to retrieve the ID token.
 
@@ -205,7 +205,7 @@ By doing this, the application can then use the token to create a {sgw} session.
 image::client-auth.png[]
 
 . The Google SignIn SDK prompts the user to login and if successful it returns an ID token to the application.
-. The ID token is used to create a {sgw} session by sending a POST `+/\{tkn-db}/_session+` request.
+. The ID token is used to create a {sgw} session by sending a POST `+/{db}/_session+` request.
 . {sgw} returns a cookie session in the response header.
 . The {sgw} cookie session is used on the replicator object.
 

modules/ROOT/pages/changes-feed.adoc

@@ -41,7 +41,7 @@ For instance, if you have a channel called 'needs-email', you could have a bot t
 == Endpoint
 
 
-The changes feed API is a REST API endpoint (xref:rest-api.adoc#/database/get\__db___changes[`+/\{tkn-db}/_changes+`]) that returns a sorted list of changes made to documents in the database.
+The changes feed API is a REST API endpoint (xref:rest-api.adoc#/database/get\__db___changes[`+/{db}/_changes+`]) that returns a sorted list of changes made to documents in the database.
 It permits applications to implement business logic that reacts to changes in documents.
 
 

modules/ROOT/pages/database-management.adoc

@@ -93,8 +93,8 @@ Set the expiry time to be sufficient to allow for all other devices to sync and
 |Tombstones are automatically purged from the bucket based on the server's metadata purge interval.
 
 |Manual
-|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/\{tkn-db}/_purge+] endpoint, or deleting documents directly in the bucket.
-|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/\{tkn-db}/_purge+] endpoint.
+|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/{db}/_purge+] endpoint, or deleting documents directly in the bucket.
+|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/{db}/_purge+] endpoint.
 |===
 
 Purging of tombstones is also required on Couchbase Lite.
@@ -123,7 +123,7 @@ Purged On
 | Couchbase Server
 | Restarting Sync Gateway will flush the cache
 | * Restarting Sync Gateway will flush the cache
-* Running the {rest-api-admin--pfx}#/database/post\__db___compact[+/\{tkn-db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211}
+* Running the {rest-api-admin--pfx}#/database/post\__db___compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211}
 
 | Sync Gateway
 a| * Restarting Sync Gateway will flush the cache.
@@ -166,7 +166,7 @@ To update the Sync Function and fully resync, you are recommended to follow the
 NOTE: This is an expensive operation because it requires every document in the database to be processed by the new function.
 
 The database can accept no requests until this process is complete because no user's full access privileges are known until all documents have been scanned.
-Therefore, the Sync Function update will result in application downtime whilst the database is offline (that is, between the call to the `+/{tkn-db}/_offline+` and `+/{tkn-db}/_online+` endpoints in <<steps-to-resync>>.
+Therefore, the Sync Function update will result in application downtime whilst the database is offline (that is, between the call to the `+/{db}/_offline+` and `+/{db}/_online+` endpoints in <<steps-to-resync>>.
 
 
 [#steps-to-resync]
@@ -176,15 +176,15 @@ Therefore, the Sync Function update will result in application downtime whilst t
 . Restart Sync Gateway
 . Take the database offline +
 Use this Admin REST API endpoint: +
-{rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{tkn-db}/_offline+]
+{rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{db}/_offline+]
 . Resync the database +
 Use this Admin REST API endpoint: +
-{rest-api-admin--pfx}#/Database_Management/post\/post__db___resync[+/{tkn-db}/resync+]
+{rest-api-admin--pfx}#/Database_Management/post\/post__db___resync[+/{db}/resync+]
 +
 The message body of the response contains the number of changes that were made as a result of calling resync
 . Bring the database back online +
 Use this Admin REST API endpoint: +
-{rest-api-admin--pfx}#/Database_Management/post\__db___online[+/{tkn-db}/_online+]
+{rest-api-admin--pfx}#/Database_Management/post\__db___online[+/{db}/_online+]
 ****
 
 === Uses
@@ -210,7 +210,7 @@ Running a resync operation does not revoke access to that document.
 If you need to ensure access to the database during the update, you can create a read-only backup of the Sync Gateway's bucket beforehand, then run a secondary Sync Gateway on the backup bucket, in read-only mode.
 After the update is complete, switch to the main Gateway and bucket.
 
-In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration, so they all need to be taken offline either by stopping the process or taking them offline using the {rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{tkn-db}/_offline+] endpoint.
+In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration, so they all need to be taken offline either by stopping the process or taking them offline using the {rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{db}/_offline+] endpoint.
 After the configuration is updated, *one* instance should be brought up so it can update the database--if more than one is running at this time, they'll conflict with each other.
 After the first instance finishes opening the database, the others can be started.
 

modules/ROOT/pages/database-offline.adoc

@@ -40,13 +40,13 @@ Specific uses for the database offline/online functionality include:
 
 == Actions
 
-* Taking a database offline: {rest-api-admin--pfx}#/database/post\__db___offline[POST /+\{db}+/_offline]
-* Taking a database online: {rest-api-admin--pfx}#/database/post\__db___online[POST /+\{db}+/_online]
+* Taking a database offline: {rest-api-admin--pfx}#/database/post\__db___offline[POST /+{db}+/_offline]
+* Taking a database online: {rest-api-admin--pfx}#/database/post\__db___online[POST /+{db}+/_online]
 
 By default, when Sync Gateway starts, it brings all databases that are defined in the configuration file online.
 To keep a database offline when Sync Gateway starts, you can add the `offline` configuration property to the database configuration properties -- see {rest-api-admin--xref--database-configuration}.
 
-Later, to bring the database online, you can use the `+POST /\{tkn-db}/_online+` Admin REST API request.
+Later, to bring the database online, you can use the `+POST /{db}/_online+` Admin REST API request.
 
 
 == Automatic Offlining

modules/ROOT/pages/get-started-verify-install.adoc

@@ -450,9 +450,9 @@ Assuming the delete worked you should see the following response:
 
 To verify that document changes have been replicated, you can:
 
-* Monitor the {sgw} revision number returned by the database endpoint (xref:{rest-api--page}#/database/get\__db__[GET /\{tkn-db}/]).
+* Monitor the {sgw} revision number returned by the database endpoint (xref:{rest-api--page}#/database/get\__db__[GET /\{db}/]).
 The revision number increments for every change that happens on the {sgw} database.
-* Query a document by ID on the {sgw} REST API as shown in <<lbl-check-cbs>>. Use (xref:{rest-api--page}#/document/get\__db___doc_[GET /\{tkn-db}/\{id}]) -- see: {rest-api-access--xref} for more.
+* Query a document by ID on the {sgw} REST API as shown in <<lbl-check-cbs>>. Use (xref:{rest-api--page}#/document/get\__db___doc_[GET /\{db}/\{id}]) -- see: {rest-api-access--xref} for more.
 * Query a document from the Query Workbench on the {cbs} Console.
 
 

modules/ROOT/pages/managing-tombstones.adoc

@@ -163,8 +163,8 @@ Set the expiry time to be sufficient to allow for all other devices to sync and
 |Tombstones are automatically purged from the bucket based on the server's metadata purge interval.
 
 |Manual
-|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/\{tkn-db}/_purge+] endpoint, or deleting documents directly in the bucket.
-|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/\{tkn-db}/_purge+] endpoint.
+|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/{db}/_purge+] endpoint, or deleting documents directly in the bucket.
+|Tombstones can be manually removed via Sync Gateway's {rest-api-admin--pfx}#/document/post\__db___purge[+/{db}/_purge+] endpoint.
 |===
 
 Purging of tombstones is also required on Couchbase Lite.
@@ -193,7 +193,7 @@ Purged On
 | Couchbase Server
 | Restarting Sync Gateway will flush the cache
 | * Restarting Sync Gateway will flush the cache
-* Running the {rest-api-admin--pfx}#/database/post\__db___compact[+/\{tkn-db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211}
+* Running the {rest-api-admin--pfx}#/database/post\__db___compact[+/{db}/_compact+] endpoint will remove purged tombstones from the channel cache {fn-211}
 
 | Sync Gateway
 a| * Restarting Sync Gateway will flush the cache.

modules/ROOT/pages/resync.adoc

@@ -13,9 +13,8 @@ include::partial$_set_page_context.adoc[]
 :param-abstract: This content explains the resync feature
 include::partial$_show_page_header_block.adoc[]
 
-:tkn-db: pass:q,a[\{db\}]
-:resync_api_post: {rest-api-admin--pfx}#/Database_Management/post__db___resync[/{tkn-db}/resync]
-:resync_api_get: {rest-api-admin--pfx}#/Database_Management/get__db___resync[/{tkn-db}/resync]
+:resync_api_post: {rest-api-admin--pfx}#/Database_Management/post__db___resync[+/{db}/_resync+]
+:resync_api_get: {rest-api-admin--pfx}#/Database_Management/get__db___resync[+/{db}/_resync+]
 
 
 == Introduction
@@ -50,7 +49,7 @@ To update the Sync Function and fully resync, you are recommended to follow the
 NOTE: This is an expensive operation because it requires every document in the database to be processed by the new function.
 
 The database can accept no requests until resync is complete because no user's full access privileges are known until all documents have been scanned.
-Therefore, the Sync Function update will result in application downtime whilst the database is offline (that is, between the call to the `/{tkn-db}/_offline` and `/{tkn-db}/_online` endpoints in <<steps-to-resync>>.
+Therefore, the Sync Function update will result in application downtime whilst the database is offline (that is, between the call to the `+/{db}/_offline+` and `+/{db}/_online+` endpoints in <<steps-to-resync>>.
 
 You won't need to run the resync operation, if either:
 
@@ -66,15 +65,15 @@ You won't need to run the resync operation, if either:
 . Restart Sync Gateway
 . Take the database offline +
 Use this Admin REST API endpoint:
-{rest-api-admin--pfx}#/Database_Management/post\__db___offline[/{tkn-db}/_offline]
+{rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{db}/_offline+]
 . Resync the database +
 Use this Admin REST API endpoint: {resync_api_post}
 . Monitor the resync status using {resync_api_get} to see when it completes.
 +
 The message body of the response contains the number of changes that were made as a result of calling resync
 . Bring the database back online +
 Use this Admin REST API endpoint:
-{rest-api-admin--pfx}#/Database_Management/post\__db___online[/{tkn-db}/_online]
+{rest-api-admin--pfx}#/Database_Management/post\__db___online[+/{db}/_online+]
 ****
 
 
@@ -84,7 +83,7 @@ Use this Admin REST API endpoint:
 Resync is run asynchronously.
 Its status can be monitored using {resync_api_get}.
 
-Be sure to take the database offline using {rest-api-admin--pfx}#/Database_Management/post\__db___offline[/{tkn-db}/_offline]
+Be sure to take the database offline using {rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{db}/_offline+]
 
 === Resync Context
 
@@ -107,7 +106,7 @@ Once you detect the resync is complete, switch back to the main Sync Gateway and
 === Updating Clusters
 
 In a clustered environment with multiple Sync Gateway instances sharing the load, all the instances need to share the same configuration.
-To ensure this happens, you must taken all instances offline using the {rest-api-admin--pfx}#/Database_Management/post\__db___offline[/{tkn-db}/_offline] endpoint.
+To ensure this happens, you must taken all instances offline using the {rest-api-admin--pfx}#/Database_Management/post\__db___offline[+/{db}/_offline+] endpoint.
 
 After the configuration is updated, *one* instance should be brought up so it can update the database--if more than one is running at this time, they'll conflict with each other.
 After the first instance finishes opening the database, the others can be started.