Add hello command reference page#51
Open
xgerman wants to merge 1 commit into
Open
Conversation
xgerman
force-pushed
the
geeichbe/docs-hello-command
branch
from
d122050 to
9d2dcfc
Compare
Document the hello diagnostic command and its DocumentDB-specific internal.documentdb_versions field, which is the recommended way to determine the DocumentDB engine version from a MongoDB client. Adds a new 'diagnostic' command category. Addresses documentdb/documentdb#547. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: German <geeichbe@microsoft.com>
xgerman
force-pushed
the
geeichbe/docs-hello-command
branch
from
9d2dcfc to
48c9e58
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds an API reference page for the
hellocommand, documenting the DocumentDB-specificinternal.documentdb_versionsfield — the recommended way to determine the DocumentDB engine version from a MongoDB client.This closes a documentation gap surfaced by documentdb/documentdb#547, where users had no documented way to discover the DocumentDB version via mongosh (
buildInfoonly reports the emulated MongoDB wire-protocol version, e.g.7.0.0).Changes
api-reference/commands/diagnostic/with a category description.hello.mdpage covering syntax (db.runCommand({ hello: 1 })and thedb.hello()helper), a return-fields table, and two examples — one showing the full response, one showing how to readinternal.documentdb_versions.Verification
Output samples were captured live against
ghcr.io/documentdb/documentdb/documentdb-local:latest(engine version 0.113-0):Related: documentdb/documentdb#547