Skip to content

RDoc-3570 Clarify usage of IdentityPartsSeparator + Fix Document IDs #2177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ppekrol merged 7 commits into from
Nov 18, 2025
Merged

RDoc-3570 Clarify usage of IdentityPartsSeparator + Fix Document IDs #2177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d678573
RDoc-3570 Fix article "document identifier generation" (v7.1)
Danielle9897 Nov 12, 2025
f317efc
RDoc-3570 Fix article "document identifier generation" (v7.0, v6.2)
Danielle9897 Nov 14, 2025
8c3c8c2
RDoc-3570 Fix desc of IdentityPartsSeparator in the conventions (C# …
Danielle9897 Nov 16, 2025
10d8f51
RDoc-3570 Fix desc of IdentityPartsSeparator in the conventions (C# …
Danielle9897 Nov 16, 2025
81ac286
RDoc-3570 Fix desc of IdentityPartsSepartor in the Identities View St…
Danielle9897 Nov 16, 2025
4b30704
RDoc-3570 Fix desc of IdentityPartsSepartor in the Put Configuration …
Danielle9897 Nov 16, 2025
0b0b54e
RDoc-3570 Fix links
Danielle9897 Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/client-api/configuration/_conventions-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,16 +750,14 @@ public Version HttpVersion \{ get; set; \}
<Admonition type="note" title="">

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

* DEFAULT: `/` (forward slash)

* The value can be any `char` except `|` (pipe).
* The value can be any char except `|` (pipe), which is reserved for identity IDs.

* Changing the separator affects these ID generation strategies:
* [Server-Side ID](../../server/kb/document-identifier-generation.mdx#strategy--2)
* [Identity](../../server/kb/document-identifier-generation.mdx#strategy--3)
* [HiLo Algorithm](../../server/kb/document-identifier-generation.mdx#strategy--4)
* DEFAULT: `/` (forward slash)

* Applies only to: [HiLo IDs](../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).

<TabItem value="IdentityPartsSeparatorSyntax" label="IdentityPartsSeparatorSyntax">
<CodeBlock language="csharp">
Expand Down
18 changes: 8 additions & 10 deletions docs/client-api/configuration/_conventions-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,16 +219,14 @@ set firstBroadcastAttemptTimeout(firstBroadcastAttemptTimeout);
<Admonition type="note" title="">

#### identityPartsSeparator
* Use the `identityPartsSeparator` convention to set the default **ID separator** for automatically-generated document IDs.

* DEFAULT: `/` (forward slash)

* The value can be any `char` except `|` (pipe).

* Changing the separator affects these ID generation strategies:
* [Server-Side ID](../../server/kb/document-identifier-generation.mdx#strategy--2)
* [Identity](../../server/kb/document-identifier-generation.mdx#strategy--3)
* [HiLo Algorithm](../../server/kb/document-identifier-generation.mdx#strategy--4)
* Use the `identityPartsSeparator` convention to customize the **default ID separator** for document IDs generated automatically by the
[HiLo algorithm](../../client-api/document-identifiers/hilo-algorithm).

* The value can be any char except `|` (pipe), which is reserved for identity IDs.

* DEFAULT: `/` (forward slash)

* Applies only to: [HiLo IDs](../../server/kb/document-identifier-generation.mdx#hilo-algorithm-id).

<TabItem value="identityPartsSeparatorSyntax" label="identityPartsSeparatorSyntax">
<CodeBlock language="js">
Expand Down
4 changes: 2 additions & 2 deletions ...t-api/operations/maintenance/configuration/_put-client-configuration-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
The following client configuration options are available:

* **Identity parts separator**:
Set the separator used with automatically generated document identity IDs (default separator is `/`).
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
Set the separator used for automatically generated document IDs (default is `/`).
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).

* **Maximum number of requests per session**:
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.
Expand Down
4 changes: 2 additions & 2 deletions ...t-api/operations/maintenance/configuration/_put-client-configuration-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
The following client configuration options are available:

* **Identity parts separator**:
Set the separator used with automatically generated document identity IDs (default separator is `/`).
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
Set the separator used for automatically generated document IDs (default is `/`).
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).

* **Maximum number of requests per session**:
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.
Expand Down
4 changes: 2 additions & 2 deletions ...ient-api/operations/maintenance/configuration/_put-client-configuration-php.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
The following client configuration options are available:

* **Identity parts separator**:
Set the separator used with automatically generated document identity IDs (default separator is `/`).
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
Set the separator used for automatically generated document IDs (default is `/`).
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).

* **Maximum number of requests per session**:
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.
Expand Down
4 changes: 2 additions & 2 deletions ...t-api/operations/maintenance/configuration/_put-client-configuration-python.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ import CodeBlock from '@theme/CodeBlock';
The following client configuration options are available:

* **Identity parts separator**:
Set the separator used with automatically generated document identity IDs (default separator is `/`).
Learn more about identity IDs creation [here](../../../../server/kb/document-identifier-generation.mdx#strategy--3).
Set the separator used for automatically generated document IDs (default is `/`).
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).

* **Maximum number of requests per session**:
Set this number to restrict the number of requests (Reads & Writes) per session in the client API.
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/maintenance/identities/_get-identities-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock';
<Admonition type="info" title="">
Learn more about identities in:

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

</Admonition>
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/maintenance/identities/_get-identities-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock';

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

* In this page:
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/maintenance/identities/_get-identities-php.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import CodeBlock from '@theme/CodeBlock';
<Admonition type="info" title="">
Learn more about identities in:

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

</Admonition>
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/maintenance/identities/_get-identities-python.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import CodeBlock from '@theme/CodeBlock';

* Learn more about identities in:

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

* In this page:
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/maintenance/identities/get-identities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"];
- [Type-specific ID Generation Conventions](../../../../client-api/configuration/identifier-generation/type-specific)

### Knowledge Base
- [Document Identifier Generation](../../../../server/kb/document-identifier-generation#strategy--3)
- [Document Identifier Generation](../../../../server/kb/document-identifier-generation.mdx#identity-id)
- [Document Identifier Generation](../../../../server/kb/document-identifier-generation)

### Operations
Expand Down
Loading