[Internal] Documentation: Adds SDK and Gateway Sequence Diagram. #4287
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ealsur
reviewed
Feb 1, 2024
|
|
||
| The scope of this sequence diagram is to capture the compute/ routing gateway interactions with the `CosmosClient` configured in `Direct` mode. | ||
|
|
||
| ## Sequence Diagram to Read Database and Collection Information. |
There was a problem hiding this comment.
Suggested change
| ## Sequence Diagram to Read Database and Collection Information. | |
| ## Sequence Diagram to Read Database and Container Information. |
ealsur
reviewed
Feb 1, 2024
| participant E as GatewayAddressCache <br> [v3 Code] | ||
| participant F as GatewayStoreModel <br> [v3 Code] | ||
| participant G as CosmosHttpClient <br> [v3 Code] | ||
| participant H as Routing Gateway <br> [Deployed on each Region] |
There was a problem hiding this comment.
Suggested change
| participant H as Routing Gateway <br> [Deployed on each Region] | |
| participant H as Gateway <br> [Deployed on each Region] |
ealsur
reviewed
Feb 1, 2024
| G-->>F: Collection <br> Metadata Information | ||
| F-->>C: Collection <br> Metadata Information | ||
| C-->>A: Collection <br> Metadata Information | ||
| ``` |
There was a problem hiding this comment.
This is not just read database and container, this is client initialization, right?
ealsur
reviewed
Feb 1, 2024
| C-->>A: Collection <br> Metadata Information | ||
| ``` | ||
|
|
||
| ## Sequence Diagram to Read PkRange and Address Information. |
There was a problem hiding this comment.
When do these happen? Should we explain? Or link to the docs?
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
The scope of this PR is to create a sequence diagram to capture the compute/ routing gateway interactions with the
CosmosClientconfigured inDirectmode.Type of change
Please delete options that are not relevant.
Closing issues
To automatically close an issue: closes #IssueNumber