DOC-13103-updated the description for bootstrap.server #7617
Conversation
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
Redocly previews |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR expands the bootstrap.server description to provide in-depth guidance on connection string formats, examples, port requirements, alternate addresses, network parameters, and reconnection behavior.
- Replaced brief server description with a detailed multiline block
- Added IPv4/IPv6 examples, port guidance, and network parameter options
- Explained startup fallback and reconnection logic
Comments suppressed due to low confidence (2)
docs/api/components/schemas.yaml:2072
- [nitpick] Inline comments using
//within the backtick-enclosed examples can be confusing; consider moving the explanatory text outside the code snippet or using parentheses so the example remains a valid code literal.
- `http://[2001:db8::8811]:8091` // single node IPv6 - http scheme with default server port
docs/api/components/schemas.yaml:2076
- [nitpick] The port requirements section applies only to
couchbase://andcouchbases://schemes—consider clarifying thathttp://connections default to the management port (8091) instead of the bucket port.
**Port Requirements**
torcolvin
reviewed
Jul 8, 2025
Collaborator
torcolvin
left a comment
torcolvin
left a comment
There was a problem hiding this comment.
I did not preview the suggested changes, but I notice some markdown oddities. To preview this document locally:
npx @redocly/cli@latest preview-docs admin
and expand response on http://127.0.0.1:8080/#tag/Server/operation/get__config
Contributor
Author
|
I have updated these, let me know if you've got any more feedback or if I missed anything. |
torcolvin
approved these changes
Jul 11, 2025
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.
DOC-13103
Describe your PR here...
I didn't find a style guide for updating these, let me know if there's one.