DOC-614 | Add Options API #425
Merged
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
|
Deploy Preview Available Via |
jsteemann
reviewed
Jan 12, 2024
Comment on lines
337
to
342
| Alternatively, you can connect to an `arangod` instance with an | ||
| [ArangoShell](../../components/tools/arangodb-shell/_index.md) and invoke a | ||
| [JavaScript Transaction](../../develop/transactions/javascript-transactions.md) | ||
| by calling `db._executeTransaction()` with the following function to retrieve the | ||
| server options, but this is limited to Coordinators and single servers with | ||
| JavaScript/V8 enabled: |
There was a problem hiding this comment.
I think we should stop recommending the JavaScript variant, as now a proper alternative is available.
There was a problem hiding this comment.
My thought was that people may look at the eventually stable 3.12 documentation and try to use the HTTP API but it's not available in 3.11 and older, and keeping the old variant allows me to reference it in the release notes - I generally avoid linking between versions. But I think we can go with your suggestion
nerpaula
approved these changes
Jan 15, 2024
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.
Description
type: objectleads to only Response Body be rendered (after the response description). This is okay IMO, but it would be nicer if we could properly document endpoints like these usingpatternPropertiesand then a structured description of the sub-objects currently explained in free-textNo curl examples added because of potentially sensitive information in the reply / extremely long output.
Preview: https://deploy-preview-425--docs-hugo.netlify.app/devel/develop/http-api/administration/#get-the-startup-option-configuration
Upstream PRs