You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 14, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: studio-docs/source/contracts.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,7 @@ Additional guidance is provided in [Special cases](#special-cases).
126
126
127
127
After you're done adding tags, update your source variant by registering your updated subgraph schemas to Apollo Studio.
128
128
129
-
> After registering, if Studio doesn't reflect the the tags that you've added in your subgraphs schemas, make sure you've [updated all required libraries and tools](#update-your-gateway-and-subgraphs). If you obtain your subgraph schemas via introspection, older subgraph libraries might strip the `@tag` directive.
129
+
> After registering, if Studio doesn't reflect the the tags that you've added in your subgraphs schemas, make sure you've [updated all required libraries and tools](#1-update-your-gateway-and-subgraphs). If you obtain your subgraph schemas via introspection, older subgraph libraries might strip the `@tag` directive.
Copy file name to clipboardExpand all lines: studio-docs/source/explorer/embed-explorer.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -235,7 +235,7 @@ A URI-encoded operation to populate in the Explorer's editor on load.
235
235
236
236
If you omit this, the Explorer initially loads an example query based on your schema.
237
237
238
-
If [`shouldPersistState`](#shouldpersiststate) is `true`_and_ you provide this option, the Explorer loads any of the user's tabs from `localStorage`, and it _also_ opens a _new_ tab with this operation.
238
+
If [`persistExplorerState`](#persistexplorerstate) is `true`_and_ you provide this option, the Explorer loads any of the user's tabs from `localStorage`, and it _also_ opens a _new_ tab with this operation.
Copy file name to clipboardExpand all lines: studio-docs/source/metrics/usage-reporting.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ After you obtain a graph API key, assign it to the `APOLLO_KEY` environment vari
31
31
32
32
Now the next time you start your production server, it automatically begins pushing trace data to Studio.
33
33
34
-
You can also push trace data from environments besides production, such as a staging or beta server. To keep this data separate from your production data, learn how to [create variants of your graph](./org/graphs/#managing-variants).
34
+
You can also push trace data from environments besides production, such as a staging or beta server. To keep this data separate from your production data, learn how to [create variants of your graph](/org/graphs/#managing-variants).
35
35
36
36
For advanced configuration options, see [Metrics and logging](https://www.apollographql.com/docs/apollo-server/features/metrics/).
37
37
@@ -68,7 +68,7 @@ Apollo Studio's reporting endpoint accepts batches of traces that are encoded in
68
68
69
69
The schema for this protocol buffer is defined as the `Report` message in the [TypeScript reference implementation](https://github.com/apollographql/apollo-server/blob/main/packages/apollo-reporting-protobuf/src/reports.proto).
70
70
71
-
> This document describes how to create a report whose `tracesPerQuery` objects consist solely of a list of detailed execution traces in the `trace` array. Apollo Studio now allows your server to describe usage as a mix of detailed execution traces and pre-aggregated statistics (released in Apollo Server 2.24), which leads to much more efficient reports. This document does not yet describe how to generate these statistics. It also does not describe how to support the "referencing operations" feature of [the Fields page](../field-usage/).
71
+
> This document describes how to create a report whose `tracesPerQuery` objects consist solely of a list of detailed execution traces in the `trace` array. Apollo Studio now allows your server to describe usage as a mix of detailed execution traces and pre-aggregated statistics (released in Apollo Server 2.24), which leads to much more efficient reports. This document does not yet describe how to generate these statistics. It also does not describe how to support the "referencing operations" feature of [the Fields page](./field-usage/).
72
72
73
73
As a starting point, we recommend implementing an extension to the GraphQL execution that creates a report with a single trace, as defined in the `Trace` message of [the protobuf schema](https://github.com/apollographql/apollo-server/blob/main/packages/apollo-reporting-protobuf/src/reports.proto). Then, you can batch multiple traces into a single report. We recommend sending batches approximately every 20 seconds, and limiting each batch to a reasonable size (~4MB).
Copy file name to clipboardExpand all lines: studio-docs/source/org/graphs.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ When a user opens one of your graph's variants in Apollo Studio, its **README pa
38
38
39
39
Like the typical homepage for a Git repository, this page displays a Markdown-based README that you can edit with any content you like.
40
40
41
-
> **Note:** Only organization members with the [`Org Admin`, `Graph Admin`, or `Contributor` role](./org/members/) can edit a variant's README. If a variant is [protected](./org/graphs/#protected-variants-enterprise-only), `Contributor`s _cannot_ edit its README.
41
+
> **Note:** Only organization members with the [`Org Admin`, `Graph Admin`, or `Contributor` role](/org/members/) can edit a variant's README. If a variant is [protected](#protected-variants-enterprise-only), `Contributor`s _cannot_ edit its README.
42
42
43
43
**Each variant has its own README.** If you edit one variant's README, those edits are _not_ applied to other variants. Among other uses, this enables you to provide different information to external consumers in a [public variant](#public-variants).
44
44
@@ -112,15 +112,15 @@ You can enable public access for individual variants of your graph. If you do, *
112
112
* Home
113
113
* Schema
114
114
* Explorer
115
-
* You can also [embed the Explorer](../embed-explorer) on your own webpage.
115
+
* You can also [embed the Explorer](/explorer/embed-explorer/) on your own webpage.
116
116
117
117
This enables consumers of your graph to learn about your graph's schema and any special usage information (such as authentication details) that you've documented in [the public variant's README](#the-readme-page). They can also run properly authenticated operations against your graph with the Explorer.
118
118
119
119
People outside your organization can't view any _other_ pages for a public variant (Fields, Operations, etc.), and they can never view _any_ pages for private variants. New variants always start as private.
120
120
121
121
#### Making a variant public
122
122
123
-
> Only organization members with the [`Org Admin` or `Graph Admin` role](./org/members/) can toggle a variant's public visibility.
123
+
> Only organization members with the [`Org Admin` or `Graph Admin` role](/org/members/) can toggle a variant's public visibility.
124
124
125
125
1. Go to your graph's Settings page and open the Access tab.
126
126
2. Under the Variants section, toggle the switch for the variant you want to make public:
Copy file name to clipboardExpand all lines: studio-docs/source/org/members.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ You can override a member's organization-wide role for individual graphs. For ex
31
31
32
32
Members with the `Graph Admin` or `Org Admin` role can assign graph-specific roles from the Access tab of the graph's Settings page.
33
33
34
-
If a graph is made [hidden](./graphs/#setting-graph-visibility-enterprise-only), then only users with explicit overrides (as well as `Org Admins`) can see the graph.
34
+
If a graph is made [hidden](./graphs/#internal-graph-visibility-enterprise-only), then only users with explicit overrides (as well as `Org Admins`) can see the graph.
35
35
36
36
`Graph Admins` and `Org Admins` have exactly the same permissions on graphs, so you can only grant a `Graph Admin` override, not an (equivalent) `Org Admin` override.
37
37
@@ -86,7 +86,7 @@ Notably, `Billing Manager`s can't invite new members to the organization or upda
86
86
87
87
## Graph API key roles
88
88
89
-
Each [graph API key](../api-keys/) also has a corresponding member role. This role can be `Graph Admin` (the default), `Contributor`, `Observer`, or `Consumer`. A graph API key provides access only to its associated graph. It does not provide access to actions associated with organizations or users.
89
+
Each [graph API key](../api-keys/) also has a corresponding member role. This role can be `Graph Admin` (the default), `Contributor`, `Observer`, or `Consumer`. A graph API key provides access only to its associated graph. It does not provide access to actions associated with organizations or users.
90
90
91
91
Otherwise, a graph API key is equivalent in privileges to a user with the same role for the graph. For example, you can use a `Consumer` key to fetch a graph's schema, and you can use a `Graph Admin` key to manage integrations.
0 commit comments