Updating docs to include content-type header #20
+46
−9
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
joswayski
reviewed
Dec 14, 2022
Comment on lines
+30
to
+35
| { | ||
| headers: { | ||
| "x-api-key": "YOUR_API_KEY", | ||
| "Content-Type": "application/json", | ||
| }, | ||
| } |
There was a problem hiding this comment.
Is this not set by default when you send a json body?
I looked at the discord thread and I guess it depends on the HTTP client you are using, hence my preference for axios here. Perhaps a comment / section under headers in the REST api section - thoughts?
There was a problem hiding this comment.
Yea it totally depends on the client and it won't hurt by adding it on but it will totally fail if the client doesn't include it.
We can add a section for headers, but it seems slightly overkill vs just a line in the example. Im good with either though.
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 of Changes
Adding the content type header to the example snippets
Related Issues