docs: Adjustments to the API reference for apollo-server's context.
#3506
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
This isn't really relevant to the `typeDefs` or the `resolvers` and is a repetition of the example directly below it (in the `context` section). As I'm about to update the `context` docs with some important information, I'll remove this from `typeDefs` in lieu of that better placed example within `context`!
In order to correctly nest this under the `context` bullet-point, this needs to be indented the same number of characters as the first character after the bullet-point symbol!
abernix
requested review from
StephenBarlow and
trevor-scheer
as code owners
abernix
added a commit
to duncanchen/apollo-server
that referenced
this pull request
Nov 14, 2019
…#3506. This should hopefully make it more clear what information is available on the argument to `context`, and how it might need to be adjusted for each specific integration.
trevor-scheer
approved these changes
Nov 14, 2019
There was a problem hiding this comment.
This is an excellent addition, thanks for putting this together @abernix!
abernix
added a commit
that referenced
this pull request
Dec 30, 2019
* Update authentication.md I follow this example on Azure Function and it failed. After a little digging, I found out the req object is passed as "request". There may be some inconsistency in implementation. * Adjust #3455 to account for new content in #3506. This should hopefully make it more clear what information is available on the argument to `context`, and how it might need to be adjusted for each specific integration. Co-authored-by: Jesse Rosenberger <git@jro.cc>
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.
As made clear by #3455, our documentation was previously lacking with regards to what the
contextmethod actually receives for each integration. (And most problematicaly, it failed to note that it was integration-specific!This should hopefully make it more clear, and we can follow-up on #3455 to actually reference this new content.
I've also made a couple other adjustments within this PR, but I think this adds some clarity, and improves the formatting.