Skip to content

Commit 1d24b72

Browse files
committed
DOC-12386: Replace {tkn-db} (#854)
* Replace {tkn-db} * Remove double escaping
1 parent f6d013e commit 1d24b72

16 files changed

Lines changed: 119 additions & 124 deletions

modules/ROOT/pages/_partials/_define_page_index.adoc

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -632,26 +632,26 @@ endif::xref--pfx-sgw[]
632632
:rest-api-admin--xref: {rest-api-admin--pfx}[Admin REST API]
633633

634634

635-
:rest-api-admin--pfx--database-configuration: {rest-api-admin--pfx}#/Database_Configuration/
635+
:rest-api-admin--pfx--database-configuration: xref:rest_api_admin.adoc#tag/Database-Configuration
636636
:rest-api-admin--xref--database-configuration: {rest-api-admin--pfx--database-configuration}[Database Configuration]
637-
:rest-api-admin--xref--database-security: {rest-api-admin--pfx}#/Database_Security[Database Security]
638-
:rest-api-admin--xref--access-control: {rest-api-admin--pfx}#/Access_Control[Access Control]
639-
:rest-api-admin--xref--import-filter: {rest-api-admin--pfx--database-configuration}update_import_filter[/\{db}/_config/import_filter]
640-
:rest-api-admin--xref--sync-function: {rest-api-admin--pfx--database-configuration}/update_sync_function[\{db\}/_config/sync]
641-
:rest-api-admin--xref--replication: {rest-api-admin--pfx}#/Replication[Replication]
637+
:rest-api-admin--xref--database-security: xref:rest_api_admin.adoc#tag/Database-Security[Database Security]
638+
:rest-api-admin--xref--access-control: xref:rest_api_admin.adoc#tag/Authentication[Authentication]
639+
:rest-api-admin--xref--import-filter: {rest-api-admin--pfx--database-configuration}/operation/put_keyspace-_config-import_filter[/\{keyspace}/_config/import_filter]
640+
:rest-api-admin--xref--sync-function: {rest-api-admin--pfx--database-configuration}/operation/put_keyspace-_config-sync[\{keyspace\}/_config/sync]
641+
:rest-api-admin--xref--replication: xref:rest_api_admin.adoc#tag/Replication[Replication]
642642

643-
:rest-api-admin-role-get--xref: {rest-api-admin--pfx}#/role/get__db___role__name_[/\{tkn-db}/_role/]
644-
:rest-api-admin-role-post--xref: {rest-api-admin--pfx}#/role/post__db___role[/\{tkn-db}/_role/]
645-
:rest-api-admin-role-put--xref: {rest-api-admin--pfx}#/role/put__db___role__name_[/\{tkn-db}/_role/\{name}]
643+
:rest-api-admin-role-get--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_role-name[/\{db}/_role/\{name}]
644+
:rest-api-admin-role-post--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_role-[/\{db}/_role/]
645+
:rest-api-admin-role-put--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_role-name[/\{db}/_role/\{name}]
646646

647-
:rest-api-admin-user-get--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{tkn-db}/_user/\{name}]
648-
:rest-api-admin-user-post--xref: {rest-api-admin--pfx}#/user/post\__db___user_[/\{tkn-db}/_user]
649-
:rest-api-admin-user-put--xref: {rest-api-admin--pfx}#/user/post\__db___user_name_[/\{tkn-db}/_user/\{name}]
647+
:rest-api-admin-user-get--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/get_db-_user-name[/\{db}/_user/\{name}]
648+
:rest-api-admin-user-post--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/post_db-_user-[/\{db}/_user]
649+
:rest-api-admin-user-put--xref: xref:rest_api_admin.adoc#tag/Database-Security/operation/put_db-_user-name[/\{db}/_user/\{name}]
650650

651-
:rest-api-admin--pfx--database-management: {rest-api-admin--pfx}#/Database_Management/
652-
:rest-api-admin--xref--database-management--compact: {rest-api-admin--pfx--database-management}post__db___compact[\{db\}/_compact]
651+
:rest-api-admin--pfx--database-management: xref:rest_api_admin.adoc#tag/Database-Management
652+
:rest-api-admin--xref--database-management--compact: {rest-api-admin--pfx--database-management}/operation/post_db-_compact[\{db\}/_compact]
653653

654-
:rest-api-admin-doc-channels-get--xref: {rest-api-admin--pfx}#/database/get__db___all_docs[/\{tkn-db}/_alldocs]
654+
:rest-api-admin-doc-channels-get--xref: xref:rest_api_admin.adoc#tag/Document/operation/get_keyspace-_all_docs[/\{keyspace}/_alldocs]
655655

656656

657657
// :configuration-schema-access-control--page: rest-api-admin-access-control.adoc
@@ -663,15 +663,15 @@ endif::xref--pfx-sgw[]
663663
// :configuration-schema-database--xref-configure-model: {sgw--xref}{configuration-schema-database--page}#/configure/put__db___config[Database Configuration - Data Model]
664664

665665
:rest-api-admin-user--page: rest-api-admin.adoc
666-
:rest-api-admin-user-post--xref: {sgw--xref}{rest-api-admin--page}#/user/put__db___user__name_[\{db\}/_user/\{name\}]
666+
:rest-api-admin-user-post--xref: {sgw--xref}{rest-api-admin--page}#tag/Database-Security/operation/put_db-_user-name[\{db\}/_user/\{name\}]
667667

668668
// :configuration-schema--isgr--page: rest-api-admin-isgr.adoc
669669
// :configuration-schema--isgr--xref: {sgw--xref}{configuration-schema--isgr--page}[Inter-Sync Gateway Configuration API]
670670
// :configuration-schema--isgr--xref: {sgw--xref}{configuration-schema--isgr--page}[Sync API]
671671

672672
// :configuration-schema--isgr--xref-purge-on-removal: {sgw--xref}{configuration-schema--isgr--page}#purge-on-removal[purge_on_removal]
673673

674-
:rest-api-admin-replication--xref--put: {sgw--xref}{rest-api-admin--page}#/Replication/put__db___replication__replicationID_[Replication -- put model]
674+
:rest-api-admin-replication--xref--put: {sgw--xref}{rest-api-admin--page}#tag/Replication/operation/put_db-_replication-replicationid[Replication -- put model]
675675

676676
:rest-api-client-app--page: rest-api-client-app.adoc
677677
:rest-api-client-app--xref: {sgw--xref}{rest-api-client-app--page}[Use the REST API?]
@@ -851,25 +851,25 @@ endif::xref--pfx-sgw[]
851851
:sgw-pg-write-access: write-access.adoc
852852

853853
// :xref-sgw-bmk-icr-sgreplicate--conflict: {sgw--xref}{sgw-pg-icr-sgreplicate}#conflict-resolution[Conflict Resolution]
854-
:xref-sgw--xref-admin-api-attachment: {rest-api-admin--pfx}#/attachment
855-
:rest-api-admin--pfx-attachment-get: {xref-sgw--xref-admin-api-attachment}/get__db___doc___attachment_[Get Attachment (/\{db}/\{docid}/\{attachment})]
856-
:rest-api-admin--pfx-attachment-put: {xref-sgw--xref-admin-api-attachment}/put__db___doc___attachment_[Add/Update Attachment (/\{db}/\{docid}/\{attachment})]
857-
:rest-api-admin--pfx-attachment: {xref-sgw--xref-admin-api-attachment}[/\{db}/\{docid}/\{attachment}]
858-
859-
:xref-sgw--xref-admin-api-document: {rest-api-admin--pfx}#/document
860-
:rest-api-admin--pfx-document-get-docid: {xref-sgw--xref-admin-api-document}/get__db___doc_[get /\{db}/\{docid}]
861-
:rest-api-admin--pfx-document-post-purge: {xref-sgw--xref-admin-api-document}/post__db___purge[/\{db}/_purge]
862-
:rest-api-admin--pfx-document-put-docid: {xref-sgw--xref-admin-api-document}/put__db___doc_[put /\{db}/\{docid}]
854+
:xref-sgw--xref-admin-api-attachment: xref:rest_api_admin.adoc#tag/Document
855+
:rest-api-admin--pfx-attachment-get: {xref-sgw--xref-admin-api-attachment}/operation/get_keyspace-docid-attach[Get Attachment (/\{keyspace}/\{docid}/\{attach})]
856+
:rest-api-admin--pfx-attachment-put: {xref-sgw--xref-admin-api-attachment}/operation/put_keyspace-docid-attach[Add/Update Attachment (/\{keyspace}/\{docid}/\{attach})]
857+
:rest-api-admin--pfx-attachment: {xref-sgw--xref-admin-api-attachment}[/\{keyspace}/\{docid}/\{attach}]
858+
859+
:xref-sgw--xref-admin-api-document: xref:rest_api_admin.adoc#tag/Document
860+
:rest-api-admin--pfx-document-get-docid: {xref-sgw--xref-admin-api-document}/operation/get_keyspace-docid[get /\{keyspace}/\{docid}]
861+
:rest-api-admin--pfx-document-post-purge: {xref-sgw--xref-admin-api-document}/operation/post_keyspace-_purge[/\{keyspace}/_purge]
862+
:rest-api-admin--pfx-document-put-docid: {xref-sgw--xref-admin-api-document}/operation/put_keyspace-docid[put /\{keyspace}/\{docid}]
863863
:rest-api-admin--pfx-document: {xref-sgw--xref-admin-api-document}
864-
:xref-sgw--xref-admin-api-replication: {rest-api-admin--pfx}#/replication
865-
:xref-sgw--xref-admin-api-replication-post: {xref-sgw--xref-admin-api-replication}/post__db___replication__replicationID_
866-
: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]
864+
:xref-sgw--xref-admin-api-replication: xref:rest_api_admin.adoc#tag/Replication
865+
:xref-sgw--xref-admin-api-replication-post: {xref-sgw--xref-admin-api-replication}/operation/post_db-_replication-
866+
:rest-api-admin--pfx-replication-delete: {xref-sgw--xref-admin-api-replication}/operation/delete_db-_replication-replicationid[DELETE /\{db}/_replication/\{replicationId}]
867867
:rest-api-admin--pfx-replication-post-remote: {xref-sgw--xref-admin-api-replication-post}[remote]
868-
:rest-api-admin--pfx-replication-post: {xref-sgw--xref-admin-api-replication-post}[POST/\{tkn-url}/\{tkn-db}/_replication/example-rep-db1]
869-
: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]
870-
:rest-api-admin--pfx-replication-repstatus-query: {xref-sgw--xref-admin-api-replication}/get__db___replicationStatus__queryString_[_replicationStatus]
871-
:rest-api-admin--pfx-replication-repstatus-set: {xref-sgw--xref-admin-api-replication}/put__db___replicationStatus__replicationID__action__action_[_replicationStatus(replicationID)?action={tkn-action}]
872-
:rest-api-admin--pfx-replication-repstatus: {xref-sgw--xref-admin-api-replication}/get__db___replicationStatus__replicationID_[_replicationStatus(replicationID)]
868+
:rest-api-admin--pfx-replication-post: {xref-sgw--xref-admin-api-replication-post}[POST/\{url}/\{db}/_replication]
869+
:rest-api-admin--pfx-replication-put: {xref-sgw--xref-admin-api-replication}/operation/put_db-_replication-replicationid[PUT/\{url}/\{db}/_replication/\{replicationId}]
870+
:rest-api-admin--pfx-replication-repstatus-query: {xref-sgw--xref-admin-api-replication}/operation/get_db-_replicationStatus-replicationid[/\{db}/_replicationStatus/\{replicationid}]
871+
:rest-api-admin--pfx-replication-repstatus-set: {xref-sgw--xref-admin-api-replication}/operation/put_db-_replicationStatus-replicationid[/\{db}/_replicationStatus/\{replicationid}]
872+
:rest-api-admin--pfx-replication-repstatus: {xref-sgw--xref-admin-api-replication}/operation/get_db-_replicationStatus-replicationid[/\{db}/_replicationStatus/\{replicationid}]
873873
:rest-api-admin--pfx-replication: {xref-sgw--xref-admin-api-replication}
874874

875875
:xref-sgw-ep-public-api: {sgw--xref}{rest-api-admin--page}

modules/ROOT/pages/_partials/block_related_content_menulists.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Blog Entries
115115

116116
// tag::concept-syncfunc[]
117117
* xref:configuration-schema-access-control.adoc[Access Control]
118-
* xref:rest-api-admin.html#/Access_Control/update_sync_function[Add/Update Sync Function]
118+
* xref:rest_api_admin.adoc#tag/Database-Configuration/operation/put_keyspace-_config-sync[Add/Update Sync Function]
119119
* xref:sync-function-overview.adoc[Sync Function Overview]
120120
// end::concept-syncfunc[]
121121

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ Running highlights::
7878

7979
* REST ONLY
8080

81-
** POST databases/\{tkn-db}/_replication creates a replication using the {rep-id} specified in the body or if none specified, a unique UUID.
81+
** POST databases/\{db}/_replication creates a replication using the replication ID specified in the body or if none specified, a unique UUID.
8282

83-
** PUT databases/\{tkn-db}/_replication/\{rep-id} upserts replication {rep-id}.
83+
** PUT databases/\{db}/_replication/\{replicationID} upserts the replication with the specified ID.
8484

8585
* {enterprise} only:
8686

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This expiration time is not propagated when the document is replicated.
6969
The purge of the document does not cause it to be deleted on any other database.
7070

7171
=== Inspect a Document Expiry Value
72-
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.
72+
You can retrieve a document's expiration time, as it is returned in the response of GET xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-docid[+/{keyspace}/{docid}+] using `show_exp=true` as the querystring.
7373

7474
[source, bash]
7575
----

modules/ROOT/pages/audit-logging.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,6 @@ Above is a successful login by `user1` to retrieve a document named `doc`.
148148

149149
* xref:sgcollect-info.adoc[]
150150

151-
* xref:rest-api-admin.adoc[Admin REST API Reference]
151+
* xref:rest-api-admin.adoc[Admin REST API]
152152

153-
* xref:rest_api_admin_static.adoc[Admin REST API Reference]
153+
* xref:rest_api_admin.adoc[Admin REST API Reference]

modules/ROOT/pages/authentication-users.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ image::static-auth-provider.png[]
8888

8989
API reference:
9090

91-
- xref:rest-api.adoc#/auth/post\__db___facebook[/+\{db}+/_facebook]
92-
- xref:rest-api.adoc#/auth/post\__db___google[/+\{db}+/_google]
91+
- xref:rest_api_public.adoc#tag/Authentication/operation/post_db-_facebook[/+{db}+/_facebook]
92+
- xref:rest_api_public.adoc#tag/Authentication/operation/post_db-_google[/+{db}+/_google]
9393

9494
For other providers we recommend to use Custom Authentication or OpenID Connect.
9595

@@ -104,7 +104,7 @@ The last request creates a session.
104104

105105
image::custom-auth-flow.png[]
106106

107-
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.
107+
Given a user that has already been created, a new session for that user can be created on the Admin xref:rest_api_admin.adoc#tag/Session/operation/post_db-_session[POST /+{db}+/_session] endpoint.
108108

109109
[source,bash]
110110
----
@@ -124,7 +124,7 @@ The HTTP response body contains the credentials of the session.
124124
* *name* corresponds to the `cookie_name`
125125
* *value* corresponds to the `session_id`
126126
* *path* is the hostname of the {sgw}
127-
* *expirationDate* corresponds to the cookie's expiration time. The endpoint's {rest-api-admin--pfx}#/session/post\__db___session[API reference] contains more information about how the expiration time is automatically extended according to the user session activity.
127+
* *expirationDate* corresponds to the cookie's expiration time. The endpoint's xref:rest_api_admin.adoc#tag/Session/operation/post_db-_session[API reference] contains more information about how the expiration time is automatically extended according to the user session activity.
128128
* *secure* Whether the cookie should only be sent using a secure protocol (e.g. HTTPS)
129129
* *httpOnly* Whether the cookie should only be used when transmitting HTTP, or HTTPS, requests thus restricting access from other, non-HTTP APIs
130130

@@ -143,7 +143,7 @@ There are two implementation methods available with OpenID Connect:
143143

144144
<<implicit-flow>>::
145145
With this method, the retrieval of the ID token takes place on the device.
146-
You can then create a user session using the POST `+/\{tkn-db}/_session+` endpoint on the Public REST API with the ID token.
146+
You can then create a user session using the POST `+/{db}/_session+` endpoint on the Public REST API with the ID token.
147147
<<authorization-code-flow>>::
148148
This method relies on {sgw} to retrieve the ID token.
149149

@@ -166,32 +166,32 @@ In the algorithm dropdown, make sure to select `RS256` as the signing algorithm
166166
. Upon successful validation, {sgw} authenticates the user based on the subject and issuer in the token.
167167

168168
Since Open ID tokens are typically large, the usual approach is to use the Open ID token to obtain a {sgw} session id (using the
169-
xref:rest-api.adoc#/session/post\__db___session[POST /db/_session]
169+
xref:rest_api_public.adoc#tag/Session/operation/post_db-_session[+POST /{db}/_session+]
170170
endpoint), and then use the returned session id for subsequent authentication requests.
171171

172172
=====
173173
*Note:* This example is based on a deployment using legacy configuration.
174+
174175
[{tabs}]
175176
====
176177

177178
REST API::
178179
+
179180
--
180181
include::{examples-lib}[tags="oidc-rest-api-simple"]
182+
183+
<.> Use `register` to auto-register a {sgw} user on successful completion of the validation
181184
--
182185

183186
Configuration File::
184187
+
185188
--
186-
187189
Here is a sample {sgw} config file, configured to use the Implicit Flow.
188190

189191
include::{examples-lib}[tags="oidc-config-simple"]
190192

191-
--
192-
193193
<.> Use `register` to auto-register a {sgw} user on successful completion of the validation
194-
194+
--
195195
====
196196
=====
197197

@@ -205,7 +205,7 @@ By doing this, the application can then use the token to create a {sgw} session.
205205
image::client-auth.png[]
206206

207207
. The Google SignIn SDK prompts the user to login and if successful it returns an ID token to the application.
208-
. The ID token is used to create a {sgw} session by sending a POST `+/\{tkn-db}/_session+` request.
208+
. The ID token is used to create a {sgw} session by sending a POST `+/{db}/_session+` request.
209209
. {sgw} returns a cookie session in the response header.
210210
. The {sgw} cookie session is used on the replicator object.
211211

modules/ROOT/pages/changes-feed.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For instance, if you have a channel called 'needs-email', you could have a bot t
4141
== Endpoint
4242

4343

44-
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.
44+
The changes feed API is a REST API endpoint (xref:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`+/{keyspace}/_changes+`]) that returns a sorted list of changes made to documents in the database.
4545
It permits applications to implement business logic that reacts to changes in documents.
4646

4747

0 commit comments

Comments
 (0)