NEBULA-701 Add includeCookies field to apollo-server #6014
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit f97b6f2:
|
| @@ -21,6 +21,7 @@ export interface ApolloServerPluginLandingPageDefaultBaseOptions { | |||
| document?: string; | |||
| variables?: Record<string, string>; | |||
| headers?: Record<string, string>; | |||
| includeCookies?: boolean; | |||
There was a problem hiding this comment.
Please update the doc comment above document to mention this (or better, split it up so each of the four options here have a doc comment since that's how doc comments work).
Ideally you should also add this to LandingPageConfig as well as to the two lines that look like
const { version, __internal_apolloStudioEnv__, footer, ...rest } = options;
as explained in the comment above them. Those lines should probably also have document, variables, and headers added, oops... I guess we're kind of in the "haven't quite updated the plugin yet" state for them. The model here is a bit odd but basically works.
Please also update the doc website in docs/source/api/plugin/landing-pages.md. There's a README in docs explaining how to run the docs site locally; you can also see a Netlify deployment preview on the PR checks section.
| */ | ||
| document?: string; | ||
| /** | ||
| * Folks can configure their landing page to link to Studio Explorer with |
There was a problem hiding this comment.
Now that it's written four times I'm starting to wonder if "folks can" is the best way to start a doc string. I kinda love it and I kinda hate it. What do you think?
|
|
||
| A boolean used to set whether cookies are included in the Studio Explorer's editor on load. | ||
|
|
||
| If you omit this, the Explorer defaults includeCookies to 'false' or the current user setting. |
There was a problem hiding this comment.
includeCookies should probably be in backticks here. probably false too.
| </td> | ||
| <td> | ||
|
|
||
| A boolean used to set whether cookies are included in the Studio Explorer's editor on load. |
There was a problem hiding this comment.
I think this could a bit more explicit, like, "A boolean used to set whether Studio Explorer should include cookies in its GraphQL requests to your server." ?
glasser
force-pushed
the
hsummit/include-cookies
branch
from
c44e737 to
f97b6f2
Compare
|
Looks good to me @SilverMaiden ! I'll add a CHANGELOG entry and merge it. |
|
That's awesome, thanks!! |
This PR is the final code change part of NEBULA-701 - updating apollo server to accept the
includeCookiesoption fromLandingPageConfig.Studio-ui PR with more context
JIRA