docs: clarify params server_url & site #706
Merged
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
Release 5.3.1 Encore
Release 5.3.1 Encore 2
Update changelogs and docs upon release
Rebuild tests using Checkmk containers
Release 5.3.2
Bugfix argument_specs.yml
Update changelogs and docs upon release
github-actions
bot
added
the
documentation
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA or my organization already has a signed CLA. |
robin-checkmk
requested changes
Jan 2, 2025
robin-checkmk
approved these changes
Jan 6, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR clarifies docs that the parameters
server_url&siteare being concatenated for all API requests and thatsiteis meant NOT to be part of the parameterserver_url. This PR might be (un)related to #684.Pull request type
Please check the type of change your PR introduces:
What is the current behavior?
Currently the docs don't specify that
server_urlmust NOT contain the site appendix/directory as its part. This leads at least in my case to long troubleshootings of the modules with the error lying in this misunderstand. The creator @jgotteswinter of issue #684 might have also suffered from this docs shortcomming.What is the new behavior?
Docs are adjusted slightly to mention the parameters being concatenated and that
server_urlshall not contain thesitevalue.Other information