Skip to content

Commit d42f637

Browse files
ppekrolppekrol
authored
Merge pull request #2177 from Danielle9897/RDoc-3570-identityPartsSeparator
RDoc-3570 Clarify usage of IdentityPartsSeparator + Fix Document IDs
2 parents 12db602 + 0b0b54e commit d42f637

File tree

57 files changed

+1780
-1009
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1780
-1009
lines changed

‎docs/client-api/configuration/_conventions-csharp.mdx‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -750,16 +750,14 @@ public Version HttpVersion \{ get; set; \}
750750
<Admonition type="note" title="">
751751

752752
#### IdentityPartsSeparator
753-
* Use the `IdentityPartsSeparator` convention to set the default **ID separator** for automatically generated document IDs.
753+
* Use the `IdentityPartsSeparator` convention to customize the **default ID separator** for document IDs generated automatically by the
754+
[HiLo algorithm](../../client-api/document-identifiers/hilo-algorithm).
754755

755-
* DEFAULT: `/` (forward slash)
756-
757-
* The value can be any `char` except `|` (pipe).
756+
* The value can be any char except `|` (pipe), which is reserved for identity IDs.
758757

759-
* Changing the separator affects these ID generation strategies:
760-
* [Server-Side ID](../../server/kb/document-identifier-generation.mdx#strategy--2)
761-
* [Identity](../../server/kb/document-identifier-generation.mdx#strategy--3)
762-
* [HiLo Algorithm](../../server/kb/document-identifier-generation.mdx#strategy--4)
758+
* DEFAULT: `/` (forward slash)
759+
760+
* Applies only to: [HiLo IDs](../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
763761

764762
<TabItem value="IdentityPartsSeparatorSyntax" label="IdentityPartsSeparatorSyntax">
765763
<CodeBlock language="csharp">

‎docs/client-api/configuration/_conventions-nodejs.mdx‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -219,16 +219,14 @@ set firstBroadcastAttemptTimeout(firstBroadcastAttemptTimeout);
219219
<Admonition type="note" title="">
220220

221221
#### identityPartsSeparator
222-
* Use the `identityPartsSeparator` convention to set the default **ID separator** for automatically-generated document IDs.
223-
224-
* DEFAULT: `/` (forward slash)
225-
226-
* The value can be any `char` except `|` (pipe).
227-
228-
* Changing the separator affects these ID generation strategies:
229-
* [Server-Side ID](../../server/kb/document-identifier-generation.mdx#strategy--2)
230-
* [Identity](../../server/kb/document-identifier-generation.mdx#strategy--3)
231-
* [HiLo Algorithm](../../server/kb/document-identifier-generation.mdx#strategy--4)
222+
* Use the `identityPartsSeparator` convention to customize the **default ID separator** for document IDs generated automatically by the
223+
[HiLo algorithm](../../client-api/document-identifiers/hilo-algorithm).
224+
225+
* The value can be any char except `|` (pipe), which is reserved for identity IDs.
226+
227+
* DEFAULT: `/` (forward slash)
228+
229+
* Applies only to: [HiLo IDs](../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
232230

233231
<TabItem value="identityPartsSeparatorSyntax" label="identityPartsSeparatorSyntax">
234232
<CodeBlock language="js">

‎docs/client-api/operations/maintenance/configuration/_put-client-configuration-csharp.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
5757
The following client configuration options are available:
5858

5959
* **Identity parts separator**:
60-
Set the separator used with automatically generated document identity IDs (default separator is `/`).
61-
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
60+
Set the separator used for automatically generated document IDs (default is `/`).
61+
Applies only to [Identity IDs](../../../../server/kb/document-identifier-generation.mdx#identity-id) and [HiLo IDs](../../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
6262

6363
* **Maximum number of requests per session**:
6464
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.

‎docs/client-api/operations/maintenance/configuration/_put-client-configuration-nodejs.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
5757
The following client configuration options are available:
5858

5959
* **Identity parts separator**:
60-
Set the separator used with automatically generated document identity IDs (default separator is `/`).
61-
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
60+
Set the separator used for automatically generated document IDs (default is `/`).
61+
Applies only to [Identity IDs](../../../../server/kb/document-identifier-generation.mdx#identity-id) and [HiLo IDs](../../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
6262

6363
* **Maximum number of requests per session**:
6464
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.

‎docs/client-api/operations/maintenance/configuration/_put-client-configuration-php.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
5757
The following client configuration options are available:
5858

5959
* **Identity parts separator**:
60-
Set the separator used with automatically generated document identity IDs (default separator is `/`).
61-
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
60+
Set the separator used for automatically generated document IDs (default is `/`).
61+
Applies only to [Identity IDs](../../../../server/kb/document-identifier-generation.mdx#identity-id) and [HiLo IDs](../../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
6262

6363
* **Maximum number of requests per session**:
6464
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.

‎docs/client-api/operations/maintenance/configuration/_put-client-configuration-python.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
5757
The following client configuration options are available:
5858

5959
* **Identity parts separator**:
60-
Set the separator used with automatically generated document identity IDs (default separator is `/`).
61-
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
60+
Set the separator used for automatically generated document IDs (default is `/`).
61+
Applies only to [Identity IDs](../../../../server/kb/document-identifier-generation.mdx#identity-id) and [HiLo IDs](../../../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).
6262

6363
* **Maximum number of requests per session**:
6464
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.

‎docs/client-api/operations/maintenance/identities/_get-identities-csharp.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock';
1919
<Admonition type="info" title="">
2020
Learn more about identities in:
2121

22-
* [Document identifier generation](../../../../server/kb/document-identifier-generation.mdx#strategy--3)
22+
* [Document identifier generation - Identity ID](../../../../server/kb/document-identifier-generation.mdx#identity-id)
2323
* [Working with document identifiers](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities)
2424

2525
</Admonition>

‎docs/client-api/operations/maintenance/identities/_get-identities-nodejs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock';
1818

1919
<Admonition type="info" title="">
2020
Learn more about identities in:
21-
[Document identifier generation](../../../../server/kb/document-identifier-generation.mdx#strategy--3)
21+
[Document identifier generation - Identity ID](../../../../server/kb/document-identifier-generation.mdx#identity-id)
2222
</Admonition>
2323

2424
* In this page:

‎docs/client-api/operations/maintenance/identities/_get-identities-php.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock';
1919
<Admonition type="info" title="">
2020
Learn more about identities in:
2121

22-
* [Document identifier generation](../../../../server/kb/document-identifier-generation.mdx#strategy--3)
22+
* [Document identifier generation - Identity ID](../../../../server/kb/document-identifier-generation.mdx#identity-id)
2323
* [Working with document identifiers](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities)
2424

2525
</Admonition>

‎docs/client-api/operations/maintenance/identities/_get-identities-python.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock';
1818

1919
* Learn more about identities in:
2020

21-
* [Document identifier generation](../../../../server/kb/document-identifier-generation.mdx#strategy--3)
21+
* [Document identifier generation - Identity ID](../../../../server/kb/document-identifier-generation.mdx#identity-id)
2222
* [Working with document identifiers](../../../../client-api/document-identifiers/working-with-document-identifiers.mdx#identities)
2323

2424
* In this page:

0 commit comments

Comments
 (0)