Add X-Source header to Gravatar REST API request #368
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
hamorillo
force-pushed
the
hamorillo/360-header-app-name
branch
from
8f7307a
to
7ce041f
Compare
📲 You can test the changes from this Pull Request in Gravatar Demo by scanning the QR code below to install the corresponding build.
|
AdamGrzybkowski
approved these changes
Oct 8, 2024
docs/get-started/get-started.md
Outdated
| @@ -63,7 +63,7 @@ android { | |||
| Then you can access the API key in your app's code like this: | |||
|
|
|||
| ```kotlin | |||
| Gravatar.initialize(BuildConfig.GRAVATAR_API_KEY) | |||
| Gravatar.apiKey(BuildConfig.GRAVATAR_API_KEY).context(appContext) | |||
There was a problem hiding this comment.
Suggested change
| Gravatar.apiKey(BuildConfig.GRAVATAR_API_KEY).context(appContext) | |
| Gravatar.apiKey(BuildConfig.GRAVATAR_API_KEY) | |
| .context(appContext) // Optional |
Should we add a comment that the context is optional?
There was a problem hiding this comment.
🤔 What about:
// Optional but highly encouraged.
As it provides valuable information for us.
If the context is provided, we will extract the app name to be used in the request headers.
When the appName is available, we should send the X-Source header with that value.
I would say it should work with any context. But let's change it to prevent issues. Co-authored-by: Adam Grzybkowski <[email protected]>
hamorillo
force-pushed
the
hamorillo/360-header-app-name
branch
from
c2ae693
to
37d4926
Compare
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.
Closes #360
Description
This is a follow-up of #353.
Having the request's source can help understand how developers use the SDK and their needs.
If the app provides the SDK with the context through the
Gravatarobject, we'll use that context to extract the application's name and send it in theX-Sourceheader.Currently, we only use the
Contextfor that purpose; it's optional to provide it. When it's not provided, we won't send the header.Testing Steps
Network Inspector, verify you can see the headerNetwork Inspector, verify you CAN'T see the header