[exporter/influxdb] Update README.md to explain URL path behavior #12794
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
Updated the documentation of the mandatory endpoint parameter to specified the behavior when no path (or root path) is specified as the example doesn't include a path and the resulting behavior in that scenario (insertion of path /api/v2/write) can be surprising. Additionally, updated endpoint description to note HTTP or HTTPS can be used (as example and documentation only referenced HTTP).
|
|
|
@clarkington3, thank you for the contribution. Please sign the CLA |
Done, thanks! |
|
@jacobmarble, please review as code owner |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
djaglowski
changed the title
|
@jacobmarble, please review as code owner |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
@djaglowski Is it possible to get someone else to review my documentation change? |
|
@clarkington3, let's give the code owner 2 more weeks. If this has not been reviewed, we will mark it as an unmaintained component. cc @jacobmarble |
djaglowski
added a commit
to djaglowski/opentelemetry-collector-contrib
that referenced
this pull request
Sep 13, 2022
djaglowski
added a commit
that referenced
this pull request
Sep 13, 2022
djaglowski
approved these changes
Sep 13, 2022
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: Updated the documentation of the mandatory endpoint parameter to clarify the behavior when no path (or root path) is specified as the example doesn't include a path and the resulting behavior in that scenario (insertion of path /api/v2/write) can be surprising. Additionally, updated endpoint description to note HTTP or HTTPS can be used (as example and documentation only referenced HTTP).
Link to tracking Issue: N/A
Testing: Confirmed behavior continues to work consistently - nothing is broken, merely documenting functionality a little more explicitly.
Documentation: Made two changes to README.md file to add information on endpoint URL path functionality and that endpoint supports both HTTP and HTTPS.