fix(python): x-doc-url support wip #916
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
gratcliff
requested review from
domharrington,
ilias-t,
RyanGWU82,
llimllib and
jamestclark
llimllib
reviewed
Sep 19, 2023
llimllib
reviewed
Sep 19, 2023
llimllib
approved these changes
Sep 20, 2023
domharrington
approved these changes
Sep 20, 2023
| expect(typeof har._id).toBe('string'); | ||
| }); | ||
|
|
||
| it.todo('should add `x-documentation-url` to response headers', async function () { |
There was a problem hiding this comment.
Should we bring this test in? Are there any other SDKs that don't yet support this?
Suggested change
| it.todo('should add `x-documentation-url` to response headers', async function () { | |
| it('should add `x-documentation-url` to response headers', async function () { |
There was a problem hiding this comment.
Ruby doesn't currently support it. There's a ticket tracking it in the metrics-sdk project! Otherwise, we'll need to integrate some kind of mocking into the integration tests to support this across the board.
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.
🧰 Changes
Adding support in Python for a new configuration option,
base_log_url(e.g. "docs.example.com"), which is consumed to append a new response header,x-documentation-url(e.g. "docs.example.com/logs/${UUID}").This configuration option is supported across all other SDKs, accept for Ruby, currently. It's used both to generate a direct link to the log that ReadMe's metrics SDK has just captured, as well as to prevent double log insertion when a request is made via "Try-It" in a documentation site.
🧬 QA & Testing
Provide as much information as you can on how to test what you've done.