Merge branch 'main' into sb/audit-enums

Author: Stephen Barlow

docs/package.json

@@ -6,8 +6,8 @@
     "serve": "gatsby serve"
   },
   "dependencies": {
-    "gatsby": "^3.14.6",
-    "gatsby-theme-apollo-docs": "^6.0.0",
+    "gatsby": "3.14.6",
+    "gatsby-theme-apollo-docs": "6.0.0",
     "react": "16.13.1",
     "react-dom": "16.12.0"
   }

studio-docs/package.json

@@ -6,8 +6,8 @@
     "serve": "gatsby serve"
   },
   "dependencies": {
-    "gatsby": "^3.14.6",
-    "gatsby-theme-apollo-docs": "^6.0.0",
+    "gatsby": "3.14.6",
+    "gatsby-theme-apollo-docs": "6.0.0",
     "react": "16.13.1",
     "react-dom": "16.12.0"
   }

studio-docs/source/explorer/connecting-authenticating.mdx

@@ -25,7 +25,7 @@ Access-Control-Allow-Credentials: true
 
 ## Authentication
 
-The Explorer currently enables you to authenticate via [request headers](#request-headers), [cookies](#cookies), and [preflight scripts](#preflight-scripts-beta).
+The Explorer currently enables you to authenticate via [request headers](#request-headers), [cookies](#cookies), and [preflight scripts](#preflight-scripts).
 
 > If your graph has authentication requirements that aren't covered by these options, please contact **[email protected]** with questions or feedback.
 
@@ -52,7 +52,7 @@ Once configured, requests sent from `https://studio.apollographql.com` will carr
 
 ### Environment variables
 
-The bottom panel of the Explorer editor includes an Environment Variables tab. Here, you can provide sensitive information that you can then include in header values or [preflight scripts](#preflight-scripts-beta). This enables you to share operations (including headers) with other team members _without_ exposing sensitive data.
+The bottom panel of the Explorer editor includes an Environment Variables tab. Here, you can provide sensitive information that you can then include in header values or [preflight scripts](#preflight-scripts). This enables you to share operations (including headers) with other team members _without_ exposing sensitive data.
 
 For example, you can define a `token` environment variable like so:
 
@@ -101,6 +101,76 @@ To create a preflight script:
 
 You're done! After you save your script, it's automatically loaded for any team member that uses the Explorer with the associated variant.
 
+#### Preflight script API reference
+
+These functions are available within the scope of a preflight script. Snippets for each are available via the **Show snippets** link in the preflight script dialog.
+
+<table class="field-table api-ref">
+  <thead>
+    <tr>
+      <th>Name /<br/>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+
+<tbody>
+
+<tr>
+<td>
+
+##### `explorer.environment.get`
+
+`(key: string) => Readonly`
+</td>
+<td>
+
+Function that returns the current value of the environment variable with the specified `key`.
+</td>
+</tr>
+
+<tr>
+<td>
+
+##### `explorer.environment.set`
+
+`(key: string, value: JSONValue) => void`
+</td>
+<td>
+
+Function that sets a new value for the environment variable with the specified `key`.
+</td>
+</tr>
+
+<tr>
+<td>
+
+##### `explorer.fetch`
+
+`(href: string, options?: { method?: string, body?: string | null, headers?: Record<string, string> }) => Promise<{ code: number, body: string, json: () => any }>`
+</td>
+<td>
+
+Function for making HTTP requests to external services from within a preflight script.
+</td>
+</tr>
+
+<tr>
+<td>
+
+##### `explorer.prompt`
+
+`(msg: string, defaultResponse?: string) => Promise<string | null>`
+</td>
+<td>
+
+Function that prompts the user for input and returns the value in a promise. If the user cancels the prompt, the promise resolves to `null`.
+</td>
+</tr>
+
+</tbody>
+</table>
+
+
 #### Disabling preflight scripts
 
 By default, a variant's preflight script runs automatically before every GraphQL operation that's executed in the Explorer. Team members can temporarily disable the script from the **Preflight script** section of the Settings tab. To do so, toggle the switch to **OFF**: